From 627056135394b5d74fcf0b2a9ff079caa2db3932 Mon Sep 17 00:00:00 2001 From: Florian Kromer Date: Sun, 7 Aug 2022 14:59:18 +0200 Subject: [PATCH 1/6] add design guideline section, add atlassian guidelines --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index fd65e69..2c4cee9 100644 --- a/README.md +++ b/README.md @@ -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) @@ -47,6 +48,10 @@ the Design of Network-based Software Architectures](https://www.ics.uci.edu/~fie * [API-Security-Checklist](https://github.com/shieldfy/API-Security-Checklist) - Best practices about REST API security * [Restful API Guidelines by Zalando](https://github.com/zalando/restful-api-guidelines) - Developing Restful APIs: A Comprehensive Set of Guidelines. +### Guidelines + + * [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. + ## Standards * [JSON API](http://jsonapi.org/) - Standard for building APIs in JSON. From ca049b4b4090089fc4d01c31420501f06623c759 Mon Sep 17 00:00:00 2001 From: Florian Kromer Date: Sun, 7 Aug 2022 15:03:13 +0200 Subject: [PATCH 2/6] move ms and zalando guidelines into guidelines --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2c4cee9..e8d5b54 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,13 @@ 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 -* [Restful API Guidelines by Zalando](https://github.com/zalando/restful-api-guidelines) - Developing Restful APIs: A Comprehensive Set of Guidelines. ### Guidelines * [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. + * [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 From c66c8d48c1bd40e4a1e89c9ad4c772c0cf9036ac Mon Sep 17 00:00:00 2001 From: Florian Kromer Date: Sun, 7 Aug 2022 15:07:06 +0200 Subject: [PATCH 3/6] add cisco rest api guide --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index e8d5b54..a6ec387 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,7 @@ the Design of Network-based Software Architectures](https://www.ics.uci.edu/~fie ### Guidelines * [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. * [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. From 71178e021c0a6b5837af9a2257eb83ecce312aa1 Mon Sep 17 00:00:00 2001 From: Florian Kromer Date: Sun, 7 Aug 2022 15:09:35 +0200 Subject: [PATCH 4/6] add adidas rest api guidelines --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a6ec387..a133620 100644 --- a/README.md +++ b/README.md @@ -48,9 +48,10 @@ the Design of Network-based Software Architectures](https://www.ics.uci.edu/~fie ### Guidelines - * [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. - * [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. +* [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. +* [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 From 45d1b895cc8494c87e87e1ee3d7bea36b1af3ef1 Mon Sep 17 00:00:00 2001 From: Florian Kromer Date: Sun, 7 Aug 2022 15:12:25 +0200 Subject: [PATCH 5/6] add haufe api style guide --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a133620..1e8e035 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,7 @@ the Design of Network-based Software Architectures](https://www.ics.uci.edu/~fie * [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. +* [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. From da79a0bb43ea59e534e011480417fdd51f5880df Mon Sep 17 00:00:00 2001 From: Florian Kromer Date: Sun, 7 Aug 2022 15:15:29 +0200 Subject: [PATCH 6/6] add google cloud api design guide --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1e8e035..764bd0e 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,7 @@ the Design of Network-based Software Architectures](https://www.ics.uci.edu/~fie * [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.