Compare commits
3 Commits
4ceb173837
...
5b712e7c1c
| Author | SHA1 | Date |
|---|---|---|
|
|
5b712e7c1c | |
|
|
1953f22199 | |
|
|
6183b3f5ac |
|
|
@ -1,6 +1,6 @@
|
|||
# API Documentation for TyrePro
|
||||
|
||||
The documentation follows the OpenAPI 3.0.0 specifications. You can read the YAML files manually or use any editor like [Swagger](https://editor.swagger.io/) or similar.
|
||||
The documentation follows the [OpenAPI 3.0.0 specifications](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md). You can read the YAML files manually or use any editor like [Swagger](https://editor.swagger.io/) or similar.
|
||||
|
||||
## Getting Started
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,23 @@
|
|||
## Licence and source of pdf files
|
||||
|
||||
https://github.com/papers-we-love/papers-we-love/tree/main/api_design
|
||||
|
||||
## Inspiration
|
||||
|
||||
# General
|
||||
|
||||
https://swagger.io/resources/articles/best-practices-in-api-design/
|
||||
https://restfulapi.net/resource-naming/
|
||||
https://www.akamai.com/blog/security/rest-api-security-best-practices
|
||||
https://cloud.google.com/blog/products/api-management/restful-web-api-design-best-practices?hl=en
|
||||
https://stackoverflow.blog/2021/10/06/best-practices-for-authentication-and-authorization-for-rest-apis/
|
||||
https://www.citusdata.com/blog/2016/03/30/five-ways-to-paginate/
|
||||
https://learn.microsoft.com/en-us/azure/architecture/best-practices/api-design
|
||||
|
||||
# Examples
|
||||
|
||||
https://docs.hetzner.cloud/
|
||||
https://opensource.zalando.com/restful-api-guidelines
|
||||
|
||||
# Our decisions
|
||||
|
||||
Binary file not shown.
Binary file not shown.
|
|
@ -0,0 +1,3 @@
|
|||
Currently in sunset, which means that there will not be future development on it.
|
||||
|
||||
*Please look forward to v2.*
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1 @@
|
|||
*Currently under heavy development*
|
||||
Loading…
Reference in New Issue