openapi gui

Openapi-gui

OpenApi-gui é uma GUI para criar e editar definições OpenApi versão 3.0.x JSON/YAML. Na sua forma atual, é mais útil como uma ferramenta para iniciar e editar definições simples de abertura. As definições importadas do OpenAPI 2.0 são automaticamente convertidas em v3.0.

Para a versão anterior Swagger / OpenAPI 2.0, consulte aqui. Atualmente, essa versão é sem manutenção, além das correções de segurança.

Este projeto foi inicialmente um garfo do iodoctor de Daryl Kuhn, que por sua vez foi inspirado pelo iodoctor por Brandon West, que foi escrito em Ruby. O histórico completo do projeto é mantido no Github.

Descrição

Como funciona

Selecione uma definição existente do OpenAPI 2.0 ou 3.0.x para fazer upload ou crie uma nova definição e comece a adicionar caminhos, operações e parâmetros. Quando uma definição existente é usada, ela é analisada e formas para editar cada caminho, operação e parâmetro serão criados.

Você pode carregar uma definição existente anexando um parâmetro ?url= consulta na página inicial inicial com o valor sendo o URL para a definição que você deseja carregar. Ao usar o Docker, você pode definir o valor do parâmetro de consulta url como %2fserve para captar a definição que você passou no Docker CommandLine.

Clique em um item no menu à esquerda para começar a editar. Veja a saída JSON/YAML a qualquer momento, selecionando uma das guias "Exportar". Quando terminar, faça o download da saída para salvá -lo localmente ou copie -o em sua área de transferência. O OpenApi-Gui armazena apenas uma definição de cada vez, e isso está no armazenamento local do seu navegador. Certifique -se de salvar sua saída JSON/YAML localmente.

Antes de executar uma ação destrutiva, o OpenApi-gui salva o estado atual da definição. Em todos os outros momentos, você deve se lembrar de selecionar salvar manualmente.

Tecnologia

O OpenApi-Gui é executado totalmente do lado do cliente usando várias estruturas JavaScript, incluindo Vue.js, JQuery e Bulma para CSS.

Para colocar o aplicativo em funcionamento, basta navegar para a versão ao vivo nas páginas do Github, implantar um clone nas páginas do GitHub, implantar para o Heroku usando o botão abaixo ou clonar o repositório e apontar um navegador em index.html ou hospedar você mesmo - não poderia ser mais simples. Mais informações técnicas aqui.

Você só precisa npm install os módulos Node.js se desejar usar o servidor web incorporado openapi-gui (ou seja, se você estiver executando seu próprio servidor da Web), caso contrário, eles estão lá apenas para implantações de PaaS.

Opções da CLI

 -d, --definition    serve the given OAS definition
-l, --launch        start a web-browser pointing to the GUI
-p, --port          specify the port to run on, defaults to $PORT or 3000
-w, --write         enable writing back to the source definition

Correndo com Docker

Se você não possui um ambiente de desenvolvimento de nó local, ou se preferir executar o OpenApi-Gui em um contêiner do Docker, poderá fazer algumas etapas simples:

1. Clone o repositório.
2. Run docker build -t mermade/openapi-gui . Para construir a imagem do Docker ( mermade/openapi-gui )
3. Run docker run --name openapi-gui -p 8080:3000 -d mermade/openapi-gui para executar o servidor na porta 8080.
4. Navegue para http://localhost:8080 no seu navegador favorito.
5. Quando terminar, desligue o servidor executando docker stop openapi-gui && docker rm openapi-gui

Ou você pode puxar a imagem do Docker pré-construída:

• docker pull mermade/openapi-gui

Limitações

• O OpenApi-gui deverá dever-se referência parâmetros compartilhados.
• A definição deve ser independente, sem $ref s. É provável que isso seja resolvido (ho-ho) em breve .
• Editar um esquema de resposta / exemplo / corpo o desreferenciará.
• O OpenApi-Gui nem sempre preservará as extensões do fornecedor, por exemplo, se um parâmetro for excluído e recriado.
• O OpenApi-Gui não preservará os comentários das definições importadas no formato YAML.

PENDÊNCIA

• Consulte a lista TODO e o status atual do suporte à especificação OpenAPI 3.0.