diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..48cd07a --- /dev/null +++ b/docs/README.md @@ -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 + diff --git a/docs/api-design.pdf b/docs/api-design.pdf new file mode 100644 index 0000000..cba57d2 Binary files /dev/null and b/docs/api-design.pdf differ diff --git a/docs/fielding_dissertation.pdf b/docs/fielding_dissertation.pdf new file mode 100644 index 0000000..8163605 Binary files /dev/null and b/docs/fielding_dissertation.pdf differ