-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
backend: docs: populate initial API endpoints
- Loading branch information
1 parent
8b56b1f
commit 3f156ea
Showing
2 changed files
with
21 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# API - v0 | ||
|
||
Warning: the v0 endpoints can and will change at any time! | ||
|
||
## Book search | ||
|
||
`host/api/v0/books/search` | ||
|
||
You must supply a search query of name `title`. | ||
|
||
Example query: `host/api/v0/books/search?title=turtle+in+paradise` | ||
|
||
## Author search | ||
|
||
`host/api/v0/author/search` | ||
|
||
You must supply a search query of name `name`. | ||
|
||
Example query: `host/api/v0/author/search?name=john+green` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,3 @@ | ||
# Welcome to MkDocs | ||
# Backend documentation | ||
|
||
For full documentation visit [mkdocs.org](https://www.mkdocs.org). | ||
|
||
## Commands | ||
|
||
* `mkdocs new [dir-name]` - Create a new project. | ||
* `mkdocs serve` - Start the live-reloading docs server. | ||
* `mkdocs build` - Build the documentation site. | ||
* `mkdocs -h` - Print help message and exit. | ||
|
||
## Project layout | ||
|
||
mkdocs.yml # The configuration file. | ||
docs/ | ||
index.md # The documentation homepage. | ||
... # Other markdown pages, images and other files. | ||
Use the links in the navigation bar! |