OpenAPI

A especificação OpenAPI (anteriormente Especificação Swagger ) é um padrão para descrever interfaces de programação compatíveis com REST (API) . A especificação é financiada pela OpenAPI Initiative . A iniciativa busca a visão de fornecer um formato de descrição aberto e neutro do fabricante para serviços de API no interesse de um mundo conectado. O projeto é apoiado pela Linux Foundation .

história

A Open API Specification começou como parte do projeto de software Swagger , um open source - Framework para HTTP - Web Services . Em 2016 tornou-se um projeto autônomo gerido pela OpenAPI Initiative , cujos membros incluem empresas como Atlassian , Google , IBM , Microsoft , PayPal e SAP .

A versão atual da especificação OpenAPI é 3.1.0.

Ferramentas

O Swagger fornece uma coleção de ferramentas de código aberto para o desenvolvimento de APIs em conformidade com a especificação OpenAPI:

  • O Editor Swagger suporta a criação da definição de API
  • Swagger Codegen gera stubs de servidor e SDKs de cliente
  • A IU Swagger gera documentação

Também existem ferramentas pagas:

  • SwaggerHub para colaboração
  • SwaggerHub Enterprise para empresas, disponível na nuvem ou no local
  • Inspetor Swagger para fins de teste
  • O APITree converte as especificações OpenAPI 2.0 e 3.0 em documentação de API legível por humanos que pode ser gerenciada e compartilhada gratuitamente na nuvem por meio de um HUB.

Também existem extensões para oferecer suporte a OpenAPI para vários ambientes de desenvolvimento.

literatura

  • Stefan Sauter People, Michael Heiß, Christopher Köster: A entrada no OpenAPI v3: REST está crescendo . In: Developer Magazine . Não. 1 , 2018, p. ? ( entwickler.de [acessado em 24 de fevereiro de 2020] Versão online gratuita ).
  • Manuel Ottlik: Documento de APIs REST de acordo com o padrão OpenAPI . In: c't . Não. 5 , 2020, p. 136–139 ( heise.de [acessado em 22 de fevereiro de 2020]).

Links da web

Exemplos:

Evidência individual

  1. Especificação OpenAPI no GitHub. Recuperado em 30 de dezembro de 2019 .
  2. Sobre a Iniciativa OpenAPI. Recuperado em 30 de dezembro de 2019 .
  3. Projetos da Linux Foundation. Recuperado em 30 de dezembro de 2019 .
  4. Membros da Iniciativa OpenAPI. Recuperado em 30 de dezembro de 2019 .
  5. Versões da especificação OpenAPI. Recuperado em 24 de setembro de 2020 .
  6. Ferramentas de código aberto OpenAPI. Recuperado em 30 de dezembro de 2019 .
  7. Editor OpenAPI para Visual Studio Code. Recuperado em 30 de dezembro de 2019 .
  8. Ferramentas OpenAPI para Eclipse. Recuperado em 30 de dezembro de 2019 .