PRM_Software_AG
/
api-documentation
12
1
Fork 0
Code Issues 10 Pull Requests Activity

Some more guides

This commit is contained in:
Nico Kroll 2024-05-02 09:01:10 +02:00
parent 5b712e7c1c
commit 6ef360c66a
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/README.md
View File

@ -4,20 +4,24 @@ https://github.com/papers-we-love/papers-we-love/tree/main/api_design
## Inspiration
# General
# Naming & Best practices
https://swagger.io/resources/articles/best-practices-in-api-design/
https://cloud.google.com/apis/design/naming_convention?hl=de
https://restfulapi.net/resource-naming/
https://www.akamai.com/blog/security/rest-api-security-best-practices
https://discuss.jsonapi.org/t/how-to-organize-an-api-using-url-prefixes-or-not-to/1036
https://swagger.io/resources/articles/best-practices-in-api-design/
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
https://www.astera.com/de/type/blog/api-design-best-practices
# Tech
https://www.citusdata.com/blog/2016/03/30/five-ways-to-paginate/
https://stackoverflow.blog/2021/10/06/best-practices-for-authentication-and-authorization-for-rest-apis/
https://www.akamai.com/blog/security/rest-api-security-best-practices
# Examples
https://docs.hetzner.cloud/
https://opensource.zalando.com/restful-api-guidelines
# Our decisions
https://kubernetes.io/docs/reference/using-api/api-concepts