├── .gitattributes ├── .gitignore ├── LICENSE ├── README.md ├── SUMMARY.md ├── _config.yml ├── api-design-principles └── api-design-principles.md ├── api-design-process └── api-design-process.md ├── api-design-review-process └── api-design-review-process.md ├── api-management └── api-management.md ├── authorization └── authorization.md ├── caching └── caching.md ├── collection-resources └── collection-resources.md ├── correlation-id └── correlation-id.md ├── documentation └── documentation.md ├── error-handling └── error-handling.md ├── faq └── faq.md ├── filtering-sorting-field-selection-and-paging └── filtering-sorting-field-selection-and-paging.md ├── further-reading └── further-reading.md ├── general-guidelines └── general-guidelines.md ├── http-status-codes └── http-status-codes.md ├── http-verbs └── http-verbs.md ├── hypermedia-and-rest └── hypermedia-and-rest.md ├── introduction └── introduction.md ├── message-schema └── message-schema.md ├── relationships-and-sub-resources └── relationships-and-sub-resources.md ├── resources ├── resources.md └── restresourcemodel.png ├── response-format └── response-format.md ├── rest-principles └── rest-principles.md ├── search └── search.md ├── security-and-authentication └── security-and-authentication.md ├── type-formatting └── type-formatting.md └── uri-components └── uri-components.md /.gitattributes: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/.gitattributes -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/.gitignore -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/LICENSE -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/README.md -------------------------------------------------------------------------------- /SUMMARY.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/SUMMARY.md -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/_config.yml -------------------------------------------------------------------------------- /api-design-principles/api-design-principles.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/api-design-principles/api-design-principles.md -------------------------------------------------------------------------------- /api-design-process/api-design-process.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/api-design-process/api-design-process.md -------------------------------------------------------------------------------- /api-design-review-process/api-design-review-process.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/api-design-review-process/api-design-review-process.md -------------------------------------------------------------------------------- /api-management/api-management.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/api-management/api-management.md -------------------------------------------------------------------------------- /authorization/authorization.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/authorization/authorization.md -------------------------------------------------------------------------------- /caching/caching.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/caching/caching.md -------------------------------------------------------------------------------- /collection-resources/collection-resources.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/collection-resources/collection-resources.md -------------------------------------------------------------------------------- /correlation-id/correlation-id.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/correlation-id/correlation-id.md -------------------------------------------------------------------------------- /documentation/documentation.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/documentation/documentation.md -------------------------------------------------------------------------------- /error-handling/error-handling.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/error-handling/error-handling.md -------------------------------------------------------------------------------- /faq/faq.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/faq/faq.md -------------------------------------------------------------------------------- /filtering-sorting-field-selection-and-paging/filtering-sorting-field-selection-and-paging.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/filtering-sorting-field-selection-and-paging/filtering-sorting-field-selection-and-paging.md -------------------------------------------------------------------------------- /further-reading/further-reading.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/further-reading/further-reading.md -------------------------------------------------------------------------------- /general-guidelines/general-guidelines.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/general-guidelines/general-guidelines.md -------------------------------------------------------------------------------- /http-status-codes/http-status-codes.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/http-status-codes/http-status-codes.md -------------------------------------------------------------------------------- /http-verbs/http-verbs.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/http-verbs/http-verbs.md -------------------------------------------------------------------------------- /hypermedia-and-rest/hypermedia-and-rest.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/hypermedia-and-rest/hypermedia-and-rest.md -------------------------------------------------------------------------------- /introduction/introduction.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/introduction/introduction.md -------------------------------------------------------------------------------- /message-schema/message-schema.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/message-schema/message-schema.md -------------------------------------------------------------------------------- /relationships-and-sub-resources/relationships-and-sub-resources.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/relationships-and-sub-resources/relationships-and-sub-resources.md -------------------------------------------------------------------------------- /resources/resources.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/resources/resources.md -------------------------------------------------------------------------------- /resources/restresourcemodel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/resources/restresourcemodel.png -------------------------------------------------------------------------------- /response-format/response-format.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/response-format/response-format.md -------------------------------------------------------------------------------- /rest-principles/rest-principles.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/rest-principles/rest-principles.md -------------------------------------------------------------------------------- /search/search.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/search/search.md -------------------------------------------------------------------------------- /security-and-authentication/security-and-authentication.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/security-and-authentication/security-and-authentication.md -------------------------------------------------------------------------------- /type-formatting/type-formatting.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/type-formatting/type-formatting.md -------------------------------------------------------------------------------- /uri-components/uri-components.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Haufe-Lexware/api-style-guide/HEAD/uri-components/uri-components.md --------------------------------------------------------------------------------