Skip to content

documenting some endpoints of the api #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
niccokunzmann wants to merge 2 commits into from
Closed

documenting some endpoints of the api #76

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f373d7c
documenting some endpoints of the api
niccokunzmann Sep 14, 2019
8da87e6
link to how endpoints are defined
niccokunzmann Sep 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions docs/extend/routes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ On the backend, Flarum has three collections of routes:

* `admin` These routes are accessible under `yourforum.com/admin/`. By default, there is only one `admin` route on the backend; the rest of the admin routing happens on the frontend.

* `api` These routes are accessible under `yourforum.com/api/` and make up Flarum's JSON:API.
* `api` These routes are accessible under `yourforum.com/api/` and make up Flarum's [JSON:API].

### Defining Routes

Expand Down Expand Up @@ -203,4 +203,21 @@ return [
$document->title = 'Users';
})
];
```
```

## JSON:API
[JSON:API]: #json_api

This is an incomplete list of endpoints which Flarum provides.
Please note that [extension may provide new endpoints][data-api-endpoints] or
extend existing ones.
Please add those you use.

- Listing discussions
[/api/discussions](https://discuss.flarum.org/api/discussions)
- Listing discussions including relationships to other objects
[/api/discussions?include=user,lastPostedUser,firstPost,tags](https://discuss.flarum.org/api/discussions?include=user,lastPostedUser,firstPost,tags)
- Listing discussions in a category or tag
[/api/discussions?filter[q]=tag:TAG](https://discuss.flarum.org/api/discussions?filter[q]=tag:dev)

[data-api-endpoints]: data.html#api-endpoints