Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates core-principles/openapi-specification.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-01-30 12:08:05 +00:00
parent 0069b7b81f
commit f41cd7d335
3 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
core-principles/api-first.md
View File

@@ -1,2 +1,2 @@
# API First
Development of an API MUST always start with API design. API Design MUST be formalized in a form of an API Description.
Development of an API MUST always start with API design. An API design MUST be formalized in a form of an API description.

4
core-principles/implementation-maturity.md
View File

@@ -1,5 +1,7 @@
# Implementation Maturity
Every API design using the HTTP(S) protocol MUST implement any action afforded by a resource using the appropriate **HTTP Request Method semantics** ([Richardson Maturity Model Level 2](https://martinfowler.com/articles/richardsonMaturityModel.html#level2)).
Every API design using the HTTP(S) protocol MUST use the appropriate **HTTP Request Method semantics** ([Richardson Maturity Model Level 2](https://martinfowler.com/articles/richardsonMaturityModel.html#level2)) to implement any action afforded by a resource.
An API design implementation SHOULD include **hypermedia controls** ([Richardson Maturity Model Level 3](https://martinfowler.com/articles/richardsonMaturityModel.html#level3)).
(TODO: see HTTP Verbs Appendix)

2
core-principles/openapi-specification.md
View File

@@ -1,5 +1,5 @@
# OpenAPI Specification
Every API MUST be described using API Description format. The API Description format used MUST be the [OpenAPI Specification (formerly known as Swagger Specification) version 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md).
Every API MUST be described using an API description format. The API description format used MUST be the [OpenAPI Specification (formerly known as Swagger Specification) version 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md).
(TODO: see OpenAPI Appendix)