Improving the use of links in API Contract
Abstract
Web REST APIs have been widely used in applications that demand web communication. Although several specifications have emerged for modeling and documenting these APIs (OpenAPI and Swagger), none describe the relationships between an API's operations, which would help developers more quickly create clients for these APIs and detect security holes. Thus, the objective of this research is to develop a heuristic, extending those existing in the literature, for the automatic generation of OpenAPI Links, a mechanism defined in the OpenAPI 3.X specification, to allow the description of relationships between API operations, for example, the precedence between operations (control flow) and how the result of an operation can be used as input for a subsequent operation (data flow).
Keywords:
Heuristic, Endpoints, OpenAPI, Link
References
Akamai (2019). State of the internet / security: Retail attacks and apitraffic. https://encurtador.com.br/coGW5. Acessado em: 15-10-2020.
ErnstFriedman, J. (2017). A new year, a new specification. encurtador.com.br/jFHQZ. Acessado em: 05-03-2021.
Fielding, R. T. (2000). Rest: architectural styles and the design of network-based software architectures. Doctoral dissertation, University of California.
Ivanchikj, A. and Pautasso, C. (2020). Modeling Microservice Conversations with RESTalk. In Microservices, pages 129–146. Springer International Publishing.
Kus, D. A., Koren, I., and Klamma, R. (2020). A link generator for increasing the utility of openapi-to-graphql translations. In WWW2020 Developer Track. ACM.
OpenAPI Initiative (2021). The openapi specification: a broadly adopted industry standard for describing modern apis. https://www.openapis.org/. Acessado em: 05-03-2021.
Ratovsky, R. (2020). Oas 3.1.0-rc0 released! https://encurtador.com.br/kqvNT. Acessado em: 05-03-2021.
SmartBear (2020). The state of api 2020 report. http://encurtador.com.br/ltyFQ. Acessado em : 14-03-2020.
Swagger (2021). Links. https://swagger.io/docs/specification/links/. Acessado em: 05-03-2021.
ErnstFriedman, J. (2017). A new year, a new specification. encurtador.com.br/jFHQZ. Acessado em: 05-03-2021.
Fielding, R. T. (2000). Rest: architectural styles and the design of network-based software architectures. Doctoral dissertation, University of California.
Ivanchikj, A. and Pautasso, C. (2020). Modeling Microservice Conversations with RESTalk. In Microservices, pages 129–146. Springer International Publishing.
Kus, D. A., Koren, I., and Klamma, R. (2020). A link generator for increasing the utility of openapi-to-graphql translations. In WWW2020 Developer Track. ACM.
OpenAPI Initiative (2021). The openapi specification: a broadly adopted industry standard for describing modern apis. https://www.openapis.org/. Acessado em: 05-03-2021.
Ratovsky, R. (2020). Oas 3.1.0-rc0 released! https://encurtador.com.br/kqvNT. Acessado em: 05-03-2021.
SmartBear (2020). The state of api 2020 report. http://encurtador.com.br/ltyFQ. Acessado em : 14-03-2020.
Swagger (2021). Links. https://swagger.io/docs/specification/links/. Acessado em: 05-03-2021.
Published
2021-10-04
How to Cite
AUZIER, Richard Lucas Lima; SANTOS FILHO, Ailton; FEITOSA, Eduardo L..
Improving the use of links in API Contract. In: WORKSHOP ON SCIENTIFIC INITIATION AND UNDERGRADUATE WORKS - BRAZILIAN SYMPOSIUM ON CYBERSECURITY (SBSEG), 21. , 2021, Evento Online.
Anais [...].
Porto Alegre: Sociedade Brasileira de Computação,
2021
.
p. 272-279.
DOI: https://doi.org/10.5753/sbseg_estendido.2021.17360.
