Aprimorando o uso de Links em API Contract
Resumo
As APIs Web REST vêm sendo largamente utilizadas em aplicações que demandam comunicação Web. Embora existam especificações para modelar e documentar essas APIs (OpenAPI e Swagger) nenhuma descreve os relacionamentos entre operações de uma API, o que auxiliaria desenvolvedores a criar mais rapidamente clientes para essas APIs e a detectar falhas de segurança. Dessa forma, o objetivo desta pesquisa é desenvolver uma heurística, estendendo as existentes na literatura, para a geração automática de Links OpenAPI, um mecanismo definido na especificação OpenAPI 3.X, a fim de permitir a descrição de relacionamentos entre operações de uma API, como por exemplo, a precedência entre operações (control flow) e como o resultado de uma operação pode ser utilizado com entrada de uma operação seguinte (data flow).
Palavras-chave:
Heurística, OpenAPI, Endpoints, Link
Referências
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.
Publicado
04/10/2021
Como Citar
AUZIER, Richard Lucas Lima; SANTOS FILHO, Ailton; FEITOSA, Eduardo L..
Aprimorando o uso de Links em API Contract. In: WORKSHOP DE TRABALHOS DE INICIAÇÃO CIENTÍFICA E DE GRADUAÇÃO - SIMPÓSIO BRASILEIRO DE SEGURANÇA DA INFORMAÇÃO E DE SISTEMAS COMPUTACIONAIS (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.
