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

Sum of the first phase of updates

Browse Source
This commit is contained in:
dediejes
2021-02-15 11:24:54 +01:00
parent 82e9dd5bc9
commit 3f1391d8da
3 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -61,7 +61,7 @@ For further documentation on Spectral refer to their [documentation](https://sto
### Questions & Comments ### Questions & Comments
_Please contact_ [_Zdenek.Nemec@externals.adidas-group.com_](mailto:Zdenek.Nemec@externals.adidas-group.com), [_andrzej.jarzyna@adidas.com_](mailto:andrzej.jarzyna@adidas.com) or [_samir.amzani@adidas.com_](mailto:samir.amzani@adidas.com) _in case of questions._ _Please contact_ [_samir.amzani@adidas.com_](mailto:samir.amzani@adidas.com) or [_jesusjavier.dediego@adidas.com_](mailto:jesusjavier.dediego@adidas.com) _in case of questions._
## Intended Use Cases ## Intended Use Cases
@@ -69,6 +69,10 @@ This project is intended to provide the guidelines for design & development of A
adidas is not responsible for the usage of this software for different purposes that the ones described in the use cases. adidas is not responsible for the usage of this software for different purposes that the ones described in the use cases.
## Last Review
February 2021
## License and Software Information ## License and Software Information
© adidas AG © adidas AG

4
SUMMARY.md
View File

@@ -21,7 +21,6 @@
* [OpenAPI Specification](rest-api-guidelines/core-principles/openapi-specification.md) * [OpenAPI Specification](rest-api-guidelines/core-principles/openapi-specification.md)
* [API Design Platform](rest-api-guidelines/core-principles/design-platform.md) * [API Design Platform](rest-api-guidelines/core-principles/design-platform.md)
* [Design Maturity](rest-api-guidelines/core-principles/design-maturity.md) * [Design Maturity](rest-api-guidelines/core-principles/design-maturity.md)
* [HATEOAS](rest-api-guidelines/core-principles/HATEOAS.md)
* [Testing](rest-api-guidelines/core-principles/testing.md) * [Testing](rest-api-guidelines/core-principles/testing.md)
* [Protocol](rest-api-guidelines/protocol/README.md) * [Protocol](rest-api-guidelines/protocol/README.md)
* [HTTP](rest-api-guidelines/protocol/http.md) * [HTTP](rest-api-guidelines/protocol/http.md)
@@ -68,7 +67,4 @@
## Asynchronous API Guidelines ## Asynchronous API Guidelines
* [Introduction](asynchronous-api-guidelines/asyncapi.md) * [Introduction](asynchronous-api-guidelines/asyncapi.md)
* [Core Principles](asynchronous-api-guidelines/core-principles/README.md)
* [Platforms](asynchronous-api-guidelines/platforms/README.md)
* [Types](asynchronous-api-guidelines/types/README.md)

4
rest-api-guidelines/execution/long-running-tasks/files-upload.md
View File

@@ -47,7 +47,7 @@ It is also recommended to compress the file to be uploaded, then using these MIM
> You can find a complete reference about the MIME types [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types). > You can find a complete reference about the MIME types [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types).
### Set Maximum Size Limit ### Set Maximum Size Limit in the API Producer Side
The maximum size of the whole file **MUST** be set for the given endpoint/s in the APi upstream/backend service side. The maximum size of the whole file **MUST** be set for the given endpoint/s in the APi upstream/backend service side.
@@ -72,7 +72,7 @@ spring.http.multipart.max-request-size=128KB # the total request size for a mult
Load tests should give you metrics about the average latency of the operations. Use these metrics to calcuate the best value for the timeout settings in the upstream/backend service. Load tests should give you metrics about the average latency of the operations. Use these metrics to calcuate the best value for the timeout settings in the upstream/backend service.
The API Gateway timeout settings have to be considered for the expected timeout values, aligned with the values in the upstream/backend service. Al other components in the infrastructure **MUST** be considered for the calculation of the final metrics. The API Gateway timeout settings have to be considered for the expected timeout values, aligned with the values in the upstream/backend service. Al other components in the infrastructure **MUST** be considered for the calculation of the final metrics.
git commit
``` ```
|API Consumer/Client Timeout| ---> |External Load Balancer| ---> |API Gateway Timeout| ---> |Internal Load Balancer| ---> |Upstream/Backend Service Tiemout| |API Consumer/Client Timeout| ---> |External Load Balancer| ---> |API Gateway Timeout| ---> |Internal Load Balancer| ---> |Upstream/Backend Service Tiemout|
``` ```