Updates API.md

Auto commit by GitBook Editor
kolaente 2018-01-12 16:29:10 +01:00
parent ecf48f96c9
commit 987e54653a
7 changed files with 68 additions and 65 deletions

133
API.md

@ -1,65 +1,68 @@
# API # API
Routes marked with 🔒 need authentification. Routes marked with 🔒 need authentification.
* [Authentication](/API_Auth) * [Authentication](/API-Auth)
* [Books](/API_Books) * [Books](/API_Books)
* [Authors](/API_Authors) * [Authors](/API_Authors)
* [Publishers](/API_Publishers) * [Publishers](/API_Publishers)
* [Items](/API_Items) * [Items](/API_Items)
* [Status](/API_Status) * [Status](/API_Status)
# Routes Overview # Routes Overview
### Auth ### Auth
| Route | Method | More | | Route | Method | More |
| ----- | ------ | ---- | | --- | --- | --- |
| `/login` | POST | [More](/API_Auth#post-login) | | `/login` | POST | [More](/API_Auth#post-login) |
### Books ### Books
| Route | Method | More | | Route | Method | More |
| ----- | ------ | ---- | | --- | --- | --- |
| `/books` | GET | [More](/API_Books#get-books) | | `/books` | GET | [More](/API_Books#get-books) |
| `/books` | PUT | [More](/API_Books#put-books-) | | `/books` | PUT | [More](/API_Books#put-books-) |
| `/books/:id` | GET | [More](/API_Books#get-booksid) | | `/books/:id` | GET | [More](/API_Books#get-booksid) |
| `/books/:id` | DELETE | [More](/API_Books#delete-booksid-) | | `/books/:id` | DELETE | [More](/API_Books#delete-booksid-) |
| `/books/:id` | POST | [More](/API_Books#post-booksid-) | | `/books/:id` | POST | [More](/API_Books#post-booksid-) |
### Authors ### Authors
| Route | Method | More | | Route | Method | More |
| ----- | ------ | ---- | | --- | --- | --- |
| `/authors` | GET | [More](/API_Authors) | | `/authors` | GET | [More](/API_Authors) |
| `/authors` | PUT | [More](/API_Authors) | | `/authors` | PUT | [More](/API_Authors) |
| `/authors/:id` | GET | [More](/API_Authors) | | `/authors/:id` | GET | [More](/API_Authors) |
| `/authors/:id` | DELETE | [More](/API_Authors) | | `/authors/:id` | DELETE | [More](/API_Authors) |
| `/authors/:id` | POST | [More](/API_Authors) | | `/authors/:id` | POST | [More](/API_Authors) |
### Publishers ### Publishers
| Route | Method | More | | Route | Method | More |
| ----- | ------ | ---- | | --- | --- | --- |
| `/publishers` | GET | [More](API_Publishers) | | `/publishers` | GET | [More](API_Publishers) |
| `/publishers` | PUT | [More](API_Publishers) | | `/publishers` | PUT | [More](API_Publishers) |
| `/publishers/:id` | GET | [More](API_Publishers) | | `/publishers/:id` | GET | [More](API_Publishers) |
| `/publishers/:id` | DELETE | [More](API_Publishers) | | `/publishers/:id` | DELETE | [More](API_Publishers) |
| `/publishers/:id` | POST | [More](API_Publishers) | | `/publishers/:id` | POST | [More](API_Publishers) |
### Items ### Items
| Route | Method | More | | Route | Method | More |
| ----- | ------ | ---- | | --- | --- | --- |
| `/items` | GET | [More](API_Items) | | `/items` | GET | [More](API_Items) |
| `/items` | PUT | [More](API_Items) | | `/items` | PUT | [More](API_Items) |
| `/items/:id` | GET | [More](API_Items) | | `/items/:id` | GET | [More](API_Items) |
| `/items/:id` | DELETE | [More](API_Items) | | `/items/:id` | DELETE | [More](API_Items) |
| `/items/:id` | POST| [More](API_Items) | | `/items/:id` | POST | [More](API_Items) |
### Status ### Status
| Route | Method | More | | Route | Method | More |
| ----- | ------ | ---- | | --- | --- | --- |
| `/status` | GET | [More](API_Status) | | `/status` | GET | [More](API_Status) |
| `/status/:id` | GET | [More](API_Status) | | `/status/:id` | GET | [More](API_Status) |