Compare commits

...

9 Commits

Author SHA1 Message Date
Francois Zaninotto
1fbfebd2ae Merge pull request #128 from fkromer/patch-2
add client generator section, add openapi-generator
2022-08-08 18:27:42 +02:00
Francois Zaninotto
82ab87d8cf Merge pull request #127 from fkromer/patch-1
refactor into guideline section, add guidelines
2022-08-08 18:27:04 +02:00
Florian Kromer
53fa7b08f0 add generator section, add openapi-generator 2022-08-07 15:26:57 +02:00
Florian Kromer
da79a0bb43 add google cloud api design guide 2022-08-07 15:15:29 +02:00
Florian Kromer
45d1b895cc add haufe api style guide 2022-08-07 15:12:25 +02:00
Florian Kromer
71178e021c add adidas rest api guidelines 2022-08-07 15:09:35 +02:00
Florian Kromer
c66c8d48c1 add cisco rest api guide 2022-08-07 15:07:06 +02:00
Florian Kromer
ca049b4b40 move ms and zalando guidelines into guidelines 2022-08-07 15:03:13 +02:00
Florian Kromer
6270561353 add design guideline section, add atlassian guidelines 2022-08-07 14:59:18 +02:00

View File

@@ -3,6 +3,7 @@
A collaborative list of great resources about RESTful API architecture, development, test, and performance. Feel free to contribute to this on-going list.
* [Design](#design)
* [Guidelines](#guidelines)
* [Standards](#standards)
* [Clients](#clients)
* [PHP](#php-clients)
@@ -10,6 +11,7 @@ A collaborative list of great resources about RESTful API architecture, developm
* [Node.js](#nodejs-clients)
* [Ruby](#ruby-clients)
* [Go](#go-clients)
* [Generators](#generators)
* [Servers](#servers)
* [Directly On Top Of A RMDB](#directly-on-top-of-a-rmdb)
* [Node.js](#nodejs)
@@ -43,8 +45,16 @@ the Design of Network-based Software Architectures](https://www.ics.uci.edu/~fie
* [HATEOAS](http://timelessrepo.com/haters-gonna-hateoas) - Clear explanation on what HATEOAS is, and why you should use it.
* [How to GET a cup of coffee](http://www.infoq.com/articles/webber-rest-workflow/)
* [REST API Tutorial](http://www.restapitutorial.com/) - RestApiTutorial.com is dedicated to tracking REST API best practices and making resources available to enable quick reference and self education for the development crafts-person.
* [Microsoft REST API Guidelines](https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#readme) - The Microsoft REST API Guidelines, as a design principle, encourages application developers to have resources accessible to them via a RESTful HTTP interface.
* [API-Security-Checklist](https://github.com/shieldfy/API-Security-Checklist) - Best practices about REST API security
### Guidelines
* [Adidas REST API Guidelines](https://github.com/adidas/api-guidelines/blob/master/rest-api-guidelines/rest.md) - Adidas REST API Guidelines define standards and guidelines for building REST APIs at adidas.
* [Atlassian REST API design guidelines version 1](https://developer.atlassian.com/server/framework/atlassian-sdk/atlassian-rest-api-design-guidelines-version-1/) - This document provides guidelines to Atlassian developers who are designing REST APIs for Atlassian applications.
* [Cisco REST API Guide](https://github.com/CiscoDevNet/api-design-guide) - Guidelines for designing REST APIs at Cisco.
* [Google Cloud API design guide](https://cloud.google.com/apis/design/) - Guidelines Google follows when designing Cloud APIs and other Google APIs (REST APIs and gRPC APIs).
* [Haufe API Style Guide](https://github.com/Haufe-Lexware/api-style-guide) - Guidelines created by Haufe-Lexware CTO team.
* [Microsoft REST API Guidelines](https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#readme) - The Microsoft REST API Guidelines, as a design principle, encourages application developers to have resources accessible to them via a RESTful HTTP interface.
* [Restful API Guidelines by Zalando](https://github.com/zalando/restful-api-guidelines) - Developing Restful APIs: A Comprehensive Set of Guidelines.
## Standards
@@ -93,6 +103,10 @@ the Design of Network-based Software Architectures](https://www.ics.uci.edu/~fie
* [gopencils](https://github.com/bndr/gopencils) - Small and simple package to easily consume REST APIs.
* [resty](https://github.com/go-resty/resty) - Simple HTTP and REST client for Go inspired by Ruby rest-client.
### Generators
* [openapi-generator](https://github.com/OpenAPITools/openapi-generator) - OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3).
## Servers
### Directly On Top Of A RMDB