1. Home
  2. Documentation
  3. Sensedia Docs Guia de uso
  4. Uso da Open API

Uso da Open API

Guia sobre como utilizar a Open API

Open API é uma especificação que permite descrever APIs RESTful de forma padronizada. Ela facilita a compreensão e o uso das APIs, além de permitir a geração automática de documentação e código cliente. O Sensedia Docs oferece suporte para criar documentação de APIs usando Open API, permitindo que você descreva seus endpoints, parâmetros, respostas e outros detalhes de forma clara e estruturada.

Criando uma documentação Open API

Para criar uma documentação Open API no Sensedia Docs, siga os passos abaixo:

Adicione um novo documento

Você pode criar um novo documento .json e referenciá-lo no seu projeto, ou então vincular um documento Open API remoto.

Referencie o documento Open API

Dentro do arquivo .md, use o componente OpenAPI para referenciar o documento Open API. Por exemplo:

ou

Visualizando a documentação

Após adicionar o componente, você pode visualizar a documentação Open API diretamente no Sensedia Docs. A documentação será renderizada automaticamente, mostrando os detalhes dos endpoints, parâmetros, respostas e outros aspectos da API.

Exemplo de uso local

Quão satisfeito você está com esta página?

Nosso site utiliza cookies para habilitar funcionalidades essenciais de avaliação e notificações. Não utilizamos cookies de rastreamento para publicidade ou análise de terceiros.Saiba mais