Requisitos: O Scalar é bastante poderoso e pode gerar automaticamente código de chamada HTTP em diferentes idiomas a partir da documentação da API, usando Scalar em vez do Swagger para exibir a documentação da API.
Após o lançamento do .NET 9 ASP.NET a equipe oficial do Core anunciou que o Swashbuckle.AspNetCore (um projeto que fornece a ferramenta Swagger para a API ASP.NET Core) seria removido do modelo da API Web ASP.NET Core. Isso significa que, no futuro, quando criarmos projetos de API Web, a documentação da API do Swagger não será mais gerada automaticamente. Então, hoje, vamos tentar usar o Scalar para documentação interativa da API em nosso projeto EasySQLite .NET 9.
Link:O login do hiperlink está visível.
Os motivos para a remoção de Swagger podem ser resumidos da seguinte forma:
- Manutenção Pobre do Swashbuckle: O projeto Swashbuckle não é mais mantido ativamente pelos proprietários da comunidade, muitos problemas permanecem sem solução e uma versão oficial compatível com .NET 8 não foi lançada.
- Voltando para o Microsoft.AspNetCore.OpenApi: A equipe ASP.NET Core irá aprimorar as capacidades do Microsoft.AspNetCore.OpenApi para substituir o Swashbuckle e viabilizar a geração de documentação OpenAPI.
- Alternativas existentes: Além do Swashbuckle, outros projetos como o NSwag suportam geração de documentação OpenAPI e geração de código cliente/servidor, permitindo que desenvolvedores escolham a solução apropriada com base nas necessidades do projeto.
- Suporte aprimorado para APIs integradas: A partir ASP.NET Core 3.1, o framework passou a fornecer suporte a metadados, como o ApiExplorer. Combinado com o suporte integrado do Visual Studio e Visual Studio Code para arquivos .http, a experiência de teste e depuração de API é ainda melhor.
- Promovendo o OpenAPI como componente central: ASP.NET equipe principal planeja aprimorar ainda mais a integração do OpenAPI no .NET 9, tornando-o um componente central focado na geração de documentação OpenAPI formatada em JSON.
Escalar
Scalar é uma ferramenta poderosa e fácil de usar para geração de clientes e documentação de API, adequada para projetos de APIs de todos os tamanhos, suportando múltiplas linguagens de programação e plataformas.
Endereço de Código Aberto:O login do hiperlink está visível.
ASP.NET Core integra Escalar
Documentação integrada:O login do hiperlink está visível.
Crie um projeto ASP.NET Core 9, referenciado da seguinte forma:
Adicione serviços e middleware escalar em Program.cs, com o código da seguinte forma:
Edite WeatherForecastController.cs controlador, código da seguinte forma:
Inicie o projeto, abra seu navegador e visite:http://localhost:5088/api-docs, como mostrado na figura abaixo:
Você pode escolher gerar um código de chamada específico para bibliotecas HTTP em diferentes idiomas. Tomando a biblioteca HttpClient C# como exemplo, o código gerado é o seguinte:
Também suporta testes de interface online. Clique no botão Solicitação de Teste, preencha os dados da postagem e depois clique em enviar para enviar a solicitação, conforme mostrado abaixo:
Personalize o cliente HTTP padrão. Para equipes C#, queremos abrir a interface de documentação da API, que exibe automaticamente o código da chamada HttpClient em C#. Se você não quiser selecionar manualmente toda primeira vez, configure da seguinte forma:
Exclua o recurso Ask AI e remova o botão Ask AI Agent. Esse recurso parece um pouco redundante. O código é o seguinte:
Como mostrado abaixo:
Após a exclusão, como mostrado abaixo:
Da mesma forma, desative a funcionalidade MCP, code a seguir:
A configuração completa é a seguinte:
Adicione a autenticação JWT e carregue o cabeçalho da requisiçãoFicha de Portador
Adicionar requisitos de segurança a toda a documentação da OpenAPI, código da seguinte forma:
Como mostrado abaixo:
OpenID Connect (OIDC):O login do hiperlink está visível.
Referência:
O login do hiperlink está visível.
O login do hiperlink está visível. |
Publicado em5 minutos atrás
|
|
|
|
Senhorio|
Publicado em1 minuto atrás
|
