Documentação Scalar UI, Swagger e Openapi | CSHARP
- Documentação Scalar UI, Swagger e Openapi | CSHARP
O que é o Openapi
OpenAPI (anteriormente conhecido como Swagger) é uma especificação aberta para descrever APIs RESTful. Com OpenAPI, você pode descrever a estrutura de uma API, incluindo os endpoints, parâmetros, tipos de dados e respostas esperadas.
Tanto o Swagger UI quanto o Scalar UI usam o formato OpenAPI para descrever a API e gerar a documentação interativa.
-
Swagger utiliza o OpenAPI Specification (OAS) para gerar a documentação a partir de um arquivo swagger.json.
-
Scalar UI segue o mesmo princípio, utilizando a especificação OpenAPI para gerar a documentação e exibi-la de maneira interativa.
OpenAPI e Swagger UI/Scalar UI:
-
Swagger UI: Consome um arquivo OpenAPI (swagger.json) e exibe a documentação interativa para testar os endpoints.
-
Scalar UI: Da mesma forma, o Scalar UI consome um arquivo OpenAPI gerado e exibe a documentação de forma interativa.
Ambas as ferramentas usam o OpenAPI como a especificação para gerar e consumir a documentação das APIs.
Configuração no .NET
Abaixo estão as configurações do swagger e do scalar com versionamento