Documentação da API REST - Swagger/OpenAPI

Sterling™ Order Management O sistema fornece documentação abrangente da API REST utilizando o padrão OpenAPI 3.0, anteriormente conhecido como Swagger. Este sistema de documentação oferece uma referência completa da API, testes interativos, esquemas estruturados, recursos de pesquisa e uma interface intuitiva.

Visão geral

O sistema de documentação do Swagger/OpenAPI oferece os seguintes recursos:

  • Referência completa da API : Informações detalhadas sobre todos os pontos de extremidade da API REST disponíveis no sistema d Sterling Order Management.
  • Esquemas estruturados : definições claras das estruturas de dados de solicitação e resposta.
  • Recursos de pesquisa : encontre rapidamente APIs em todos os módulos.
  • Interface intuitiva : documentação em HTML de fácil navegação.

Benefícios

A documentação do ` Swagger/OpenAPI ` oferece os seguintes benefícios principais:

  • Integração mais rápida : os desenvolvedores podem compreender e integrar-se rapidamente às APIs do sistem Sterling Order Management.
  • Autoatendimento : explore e teste APIs sem precisar entrar em contato com o suporte.
  • Informações precisas : geradas automaticamente a partir do código-fonte, garantindo a precisão.
  • Baseado em padrões : Compatível com ferramentas de API populares, como Postman e Insomnia.
  • Sempre atualizado : atualizado a cada lançamento do sistema Sterling Order Management.

Introdução

Para começar a usar a documentação do Swagger/OpenAPI, siga estas etapas:

  1. Gere a documentação usando os comandos fornecidos.
  2. Explore os principais recursos disponíveis na documentação.
  3. Compreender a estrutura e a organização da documentação.
  4. Acesse a documentação HTML interativa ou as especificações JSON.