1.0.0-t07161051 • Published 3 years ago
gitbook-plugin-api-test v1.0.0-t07161051
Gitbook Plugin - API
Write beautiful API documentation with GitBook
This plugins requires gitbook >=2.0.0
.
Installation
Add the plugin to your book.json
, then run gitbook install
:
{
plugins: ["api"]
}
You can now start writing API documentation:
{% api "List App Pages", method="GET", url="https://www.magloft.com/api/portal/v1/app_pages/:app_id/page/:page" %}
This endpoint **returns** a list of all `app pages` that belong to the magazine
### Parameters:
| Name | Type | Desc |
| :--------- | :------ | :-------------------------------------------------- |
| **app_id** | String | App ID to list app pages for |
| **page** | Integer | The page to list |
| per_page | Integer | Number of items to show per page |
| order_by | Symbol | Field to sort results by |
| order_dir | Symbol | Direction (asc, desc) to sort results by |
| filter | String | Text filter to search pages by name, title and html |
### Response:
```json
{
"id": 1234,
"title": "Welcome to MagLoft"
}
```
{% endapi %}
1.0.0-t07151734
3 years ago
1.0.0-t07151515
3 years ago
1.0.0-t07151710
3 years ago
1.0.0-t07151655
3 years ago
1.0.0-t07161051
3 years ago
1.0.0-t07151733
3 years ago
1.0.0-t07152025
3 years ago
1.0.0-t07151610
3 years ago
1.0.0-t07151530
3 years ago
1.0.0-t07151630
3 years ago
1.0.0-t07161034
3 years ago
1.0.0-t07151452
3 years ago
1.0.0-t07152100
3 years ago
1.0.0-t07152023
3 years ago
1.0.0-t07151637
3 years ago
1.0.0-t07151715
3 years ago
1.0.0-t07151525
3 years ago
1.0.0-t07151621
3 years ago
1.0.0-t07151541
3 years ago
1.0.0-t07161045
3 years ago
1.0.0-t07152055
3 years ago
1.0.0-t07161025
3 years ago
1.0.0-t07152030
3 years ago
1.0.0-t07151945
3 years ago
1.0.0-t07151946
3 years ago
1.0.0-t06281519
3 years ago
1.0.0-t06281659
3 years ago
1.0.0-t06281527
3 years ago
1.0.0-t06281639
3 years ago
1.0.0-t06282039
3 years ago
1.0.0-t06281138
3 years ago
1.0.0-t06281423
3 years ago
1.0.0-t06281700
3 years ago
1.0.0-t06281057
3 years ago
1.0.0-t06281100
3 years ago
1.0.0-t06281532
3 years ago
1.0.0-t06281059
3 years ago
1.0.0-t06281047
3 years ago
1.0.0-t06251707
3 years ago
1.0.0-t06251704
3 years ago
1.0.0-t06251500
3 years ago
1.0.0-t06251444
3 years ago
1.0.0-t06251421
3 years ago
1.0.0-t06251151
3 years ago
1.0.0-t06251102
3 years ago
1.0.0-t0624
3 years ago