404
8 |Page not found
9 |
25 |
29 |
26 | {% include 'apistar/layout/content.html' %}
27 |
28 | 
3 |
2 |
3 |
5 | 🛠 The Web API toolkit. 🛠 6 |
7 |
8 |
9 | 
10 |
11 |
12 | 
13 |
14 |
15 | 
16 |
17 |
API Star is BSD licensed code.
Designed & built in Brighton, England.
118 |
119 | 
120 |
{% if True %}var url = new URL("{{ link.url }}");
2 | {% endif %}
3 | {%- if link.get_body_field() and not link.get_expanded_body() %}var data = ...;
4 | {% endif %}
5 | {%- if link.get_body_field() and link.get_expanded_body() %}var data = {
6 | {% for key, schema in link.get_expanded_body().items() %} {{ key }}: ...{% if not loop.last %},{% endif %}
7 | {% endfor %}};
8 | {% endif %}
9 | {%- if True %}var options = {
10 | method: "{{ link.method }}"
11 | {%- if link.get_body_field() %},
12 | body: JSON.stringify(data),
13 | headers: {
14 | "content-type": "application/json"
15 | }{% endif %}
16 | };
17 | {% endif %}
18 | {%- if link.get_query_fields() %}url.search = new URLSearchParams({
19 | {% for field in link.get_query_fields() %} {{ field.name }}: ...{% if not loop.last %},{% endif %}
20 | {% endfor %}});
21 | {% endif %}
22 | fetch(url, options).then(function(response) {
23 | if (!response.ok) {
24 | throw new Error(response.statusText);
25 | }
26 | console.log(response.json());
27 | })
28 | import requests
2 |
3 | url = "{{ link.url }}"{% raw %}
4 | {% endraw %}
5 | {%- if link.get_query_fields() %}params = {
6 | {% for field in link.get_query_fields() %} "{{ field.name }}": ...{% if not loop.last %},{% endif %}
7 | {% endfor %}}
8 | {% endif %}
9 | {%- if link.get_body_field() and not link.get_expanded_body() %}data = ...
10 | {% endif %}
11 | {%- if link.get_body_field() and link.get_expanded_body() %}data = {
12 | {% for key, schema in link.get_expanded_body().items() %} "{{ key }}": ...{% if not loop.last %},{% endif %}
13 | {% endfor %}}
14 | {% endif %}
15 | response = requests.{{ link.method.lower() }}(url{% if link.get_query_fields() %}, params=params{% endif %}{% if link.get_body_field() %}, json=data{% endif %})
16 | response.raise_for_status()
17 | print(response.json())
18 | {{ document.description }}
5 | {% endif %} 6 |{{ link.description }}
{% endif %} 12 | 13 | {% if link.get_path_fields() %} 14 |The following parameters should be included in the URL path.
16 || Parameter | Description |
|---|---|
{{ field.name }}{% if field.required %} required{% endif %} | {% if field.description or field.schema.description %}{{ field.description or field.schema.description }}{% endif %} |
The following parameters should be included as part of a URL query string.
30 || Parameter | Description |
|---|---|
{{ field.name }}{% if field.required %} required{% endif %} | {% if field.description or field.schema.description %}{{ field.description or field.schema.description }}{% endif %} |
The request body should be "{{ link.encoding }}" encoded, and should contain {% if expanded %}an object with the following attributes.{% else %}a single item.{% endif %}
| Parameter | Description |
|---|---|
{{ key }}{% if key in field.schema.required %} required{% endif %} | {% if schema.description %}{{ schema.description }}{% endif %} |
{{ field.name }}{% if field.required %} required{% endif %} | {% if field.description or field.schema.description %}{{ field.description or field.schema.description }}{% endif %} |
Page not found
9 |