Editor OpenAPI do workspace
Edição YAML/JSON, validação, pré-visualização e bloqueio de equipe.
Localização
Em cada workspace, abra o Editor OpenAPI no menu de APIs ou pelo caminho /workspaces/{id}/openapi-editor. Um workspace possui um spec OpenAPI vinculado como recurso principal.
Edição
- Conteúdo em YAML ou JSON com destaque de sintaxe no editor.
- Validação em tempo quase real: erros de sintaxe (vários ao mesmo tempo) e regras OpenAPI via o validador integrado.
- Pré-visualização tipo Swagger UI no painel direito quando o documento é válido.
Salvar
- Com erros de severidade "error" no validador, o salvamento pode estar bloqueado até que sejam corrigidos.
- Em workspaces com vários colaboradores, você deve atualizar e adquirir o bloqueio antes de editar ou salvar; em workspaces pessoais ou sem colaboradores não é exigido bloqueio.
- Conflitos de versão (outro usuário salvou antes) são resolvidos com recarga ou fluxo de mesclagem conforme exibido no modal.
Redis (ambientes locais)
O bloqueio e a presença usam Redis. Se em desenvolvimento você vir erro de serviço indisponível, inicie o Redis (ex: docker compose up redis no backend).
Importar de coleção
Você pode carregar OpenAPI gerado a partir de uma coleção ou colar um spec importado conforme as opções da própria tela.