AJUDA DO .NET

Nswag C# (Como funciona para desenvolvedores)

Atualizado:junho 22, 2025

As APIs são essenciais no ambiente de desenvolvimento de software atual porque facilitam a comunicação entre vários sistemas e componentes de software. Para que os desenvolvedores usem APIs de forma eficiente, é necessário que haja uma documentação completa e compreensível. Duas ferramentas eficazes que podem auxiliar no fluxo de trabalho de documentação de APIs em C# são o NSwag C# e o IronPDF. Este artigo abordará como usar o NSwag para gerar especificações de API com o .NET Core e produzir documentos PDF de alta qualidade a partir dessas especificações usando o IronPDF.

Como usar o NSwag em C

Crie uma API web RESTful usando o Swagger UI.
Crie um aplicativo de console em C#.
Instale a biblioteca NSwag.
Importe o namespace e crie o objeto.
Processar o JSON do Swagger para código C#.
Execute o código e exiba o resultado.

Entendendo o NSwag

Foi criada uma cadeia de ferramentas .NET Swagger chamada NSwag para facilitar a criação de especificações Swagger, ou documentos OpenAPI, para APIs construídas usando ASP.NET Web API, ASP.NET Core ou outras estruturas .NET .

Características do NSwag

Produção de especificações Swagger

Controladores, modelos e assemblies .NET podem ser usados pelo NSwag para gerar automaticamente especificações Swagger. O NSwag gera documentação completa que abrange endpoints de API, formulários de requisição/resposta, técnicas de autenticação e muito mais, examinando a estrutura do código da API.

Conectividade com projetos .NET

Os desenvolvedores podem facilmente incluir a geração de Swagger em seus processos de desenvolvimento integrando o NSwag aos projetos .NET . Os desenvolvedores podem garantir que a documentação seja atualizada com a base de código adicionando o NSwag a um projeto .NET Core , o que gerará automaticamente as especificações Swagger sempre que o projeto for compilado.

Personalização e Expansão

Com a ampla gama de possibilidades de personalização oferecidas pelo NSwag, os desenvolvedores podem facilmente adaptar as especificações Swagger geradas para atender às suas necessidades específicas. Os desenvolvedores têm controle sobre muitos componentes da documentação gerada, incluindo códigos de resposta, explicações de parâmetros e convenções de nomenclatura de rotas, por meio de configurações e anotações.

Primeiros passos com o NSwag

Configurando o NSwag em um aplicativo de console C

A Biblioteca de Classes Base NSwag inclui o núcleo, o namespace de Anotações e o namespace de geração de código, que devem estar disponíveis para instalação via NuGet. Integrar o NSwag em uma aplicação C# para gerar código e especificações Swagger, e como o NSwag pode melhorar a eficiência do processo de desenvolvimento.

NSwag C# (Como funciona para desenvolvedores): Figura 1 - Navegue até o NSwag no Gerenciador de Pacotes do Visual Studio e instale-o

Implementando NSwag no Console e no Windows Forms

Por meio da geração automatizada de clientes, os desenvolvedores podem produzir código de forma eficiente para acessar APIs diretamente de seus aplicativos de desktop, integrando o NSwag a um aplicativo de desktop Windows. Ao desenvolver aplicações desktop que se comunicam com serviços online ou APIs RESTful, isso pode ser bastante útil.

O NSwag pode ser usado em aplicações web para gerar documentação de API para APIs internas e código cliente para consumir APIs externas. Isso auxilia os desenvolvedores a manter a consistência entre os componentes de front-end e back-end de suas aplicações.

Exemplo NSwag em C

Aqui está um exemplo de código que mostra como usar o NSwag para gerar código cliente em C#:

using NSwag.CodeGeneration.CSharp;
using NSwag;
using System.Reflection;
using System.CodeDom.Compiler;
using Microsoft.CodeAnalysis;
using System.Net.Http;
using System.IO;
using System.Collections.Generic;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using (var wclient = new System.Net.WebClient())
        {
            // Create JSON file data from the Swagger .NET Core web API
            var document = await OpenApiDocument.FromJsonAsync(wclient.DownloadString("http://localhost:5013/swagger/v1/swagger.json"));
            var settings = new CSharpClientGeneratorSettings
            {
                ClassName = "Weather",
                CSharpGeneratorSettings = { Namespace = "Demo" }
            };

            var generator = new CSharpClientGenerator(document, settings);
            var code = generator.GenerateFile();
            var assembly = CompileCode(code);
            var clientType = assembly.GetType("Demo.WeatherClient"); // Replace with your actual client class name
            using (var httpClient = new HttpClient())
            {
                var client = (IApiClient)Activator.CreateInstance(clientType, httpClient);
                var result = await client.GetWeatherForecastAsync();
                foreach (var item in result)
                {
                    Console.WriteLine($"Date: {item.Date} F: {item.TemperatureF} C: {item.TemperatureC} Summary: {item.Summary}");
                }
            }
        }
    }

    static Assembly CompileCode(string code)
    {
        using (var memoryStream = new MemoryStream())
        {
            var assemblyPath = Path.GetDirectoryName(typeof(object).Assembly.Location);
            var references = new List<MetadataReference>
            {
                MetadataReference.CreateFromFile(typeof(object).GetTypeInfo().Assembly.Location),
                MetadataReference.CreateFromFile(Path.Combine(assemblyPath, "Microsoft.AspNetCore.Mvc.dll")),
                MetadataReference.CreateFromFile(Path.Combine(assemblyPath, "System.Private.CoreLib.dll"))
            };

            var compilation = Microsoft.CodeAnalysis.CSharp.CSharpCompilation.Create("ApiClient")
                .WithOptions(new Microsoft.CodeAnalysis.CSharp.CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary))
                .AddReferences(references)
                .AddSyntaxTrees(Microsoft.CodeAnalysis.CSharp.SyntaxFactory.ParseSyntaxTree(code));

            var emitResult = compilation.Emit(memoryStream);
            if (!emitResult.Success)
            {
                Console.WriteLine("Compilation errors:");
                foreach (var diagnostic in emitResult.Diagnostics)
                {
                    Console.WriteLine(diagnostic);
                }
                return null;
            }
            memoryStream.Seek(0, SeekOrigin.Begin);
            return Assembly.Load(memoryStream.ToArray());
        }
    }

    public interface IApiClient
    {
        // Replace with your actual method name and return type
        Task<List<WeatherForecast>> GetWeatherForecastAsync();
    }

    public class WeatherForecast
    {
        public DateTime Date { get; set; }
        public int TemperatureC { get; set; }
        public int TemperatureF { get; set; }
        public string Summary { get; set; }
    }
}

using NSwag.CodeGeneration.CSharp;
using NSwag;
using System.Reflection;
using System.CodeDom.Compiler;
using Microsoft.CodeAnalysis;
using System.Net.Http;
using System.IO;
using System.Collections.Generic;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using (var wclient = new System.Net.WebClient())
        {
            // Create JSON file data from the Swagger .NET Core web API
            var document = await OpenApiDocument.FromJsonAsync(wclient.DownloadString("http://localhost:5013/swagger/v1/swagger.json"));
            var settings = new CSharpClientGeneratorSettings
            {
                ClassName = "Weather",
                CSharpGeneratorSettings = { Namespace = "Demo" }
            };

            var generator = new CSharpClientGenerator(document, settings);
            var code = generator.GenerateFile();
            var assembly = CompileCode(code);
            var clientType = assembly.GetType("Demo.WeatherClient"); // Replace with your actual client class name
            using (var httpClient = new HttpClient())
            {
                var client = (IApiClient)Activator.CreateInstance(clientType, httpClient);
                var result = await client.GetWeatherForecastAsync();
                foreach (var item in result)
                {
                    Console.WriteLine($"Date: {item.Date} F: {item.TemperatureF} C: {item.TemperatureC} Summary: {item.Summary}");
                }
            }
        }
    }

    static Assembly CompileCode(string code)
    {
        using (var memoryStream = new MemoryStream())
        {
            var assemblyPath = Path.GetDirectoryName(typeof(object).Assembly.Location);
            var references = new List<MetadataReference>
            {
                MetadataReference.CreateFromFile(typeof(object).GetTypeInfo().Assembly.Location),
                MetadataReference.CreateFromFile(Path.Combine(assemblyPath, "Microsoft.AspNetCore.Mvc.dll")),
                MetadataReference.CreateFromFile(Path.Combine(assemblyPath, "System.Private.CoreLib.dll"))
            };

            var compilation = Microsoft.CodeAnalysis.CSharp.CSharpCompilation.Create("ApiClient")
                .WithOptions(new Microsoft.CodeAnalysis.CSharp.CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary))
                .AddReferences(references)
                .AddSyntaxTrees(Microsoft.CodeAnalysis.CSharp.SyntaxFactory.ParseSyntaxTree(code));

            var emitResult = compilation.Emit(memoryStream);
            if (!emitResult.Success)
            {
                Console.WriteLine("Compilation errors:");
                foreach (var diagnostic in emitResult.Diagnostics)
                {
                    Console.WriteLine(diagnostic);
                }
                return null;
            }
            memoryStream.Seek(0, SeekOrigin.Begin);
            return Assembly.Load(memoryStream.ToArray());
        }
    }

    public interface IApiClient
    {
        // Replace with your actual method name and return type
        Task<List<WeatherForecast>> GetWeatherForecastAsync();
    }

    public class WeatherForecast
    {
        public DateTime Date { get; set; }
        public int TemperatureC { get; set; }
        public int TemperatureF { get; set; }
        public string Summary { get; set; }
    }
}

Imports NSwag.CodeGeneration.CSharp
Imports NSwag
Imports System.Reflection
Imports System.CodeDom.Compiler
Imports Microsoft.CodeAnalysis
Imports System.Net.Http
Imports System.IO
Imports System.Collections.Generic
Imports System.Threading.Tasks

Friend Class Program
	Shared Async Function Main(ByVal args() As String) As Task
		Using wclient = New System.Net.WebClient()
			' Create JSON file data from the Swagger .NET Core web API
			Dim document = Await OpenApiDocument.FromJsonAsync(wclient.DownloadString("http://localhost:5013/swagger/v1/swagger.json"))
			Dim settings = New CSharpClientGeneratorSettings With {
				.ClassName = "Weather",
				.CSharpGeneratorSettings = { [Namespace] = "Demo" }
			}

			Dim generator = New CSharpClientGenerator(document, settings)
			Dim code = generator.GenerateFile()
			Dim assembly = CompileCode(code)
			Dim clientType = assembly.GetType("Demo.WeatherClient") ' Replace with your actual client class name
			Using httpClient As New HttpClient()
				Dim client = DirectCast(Activator.CreateInstance(clientType, httpClient), IApiClient)
				Dim result = Await client.GetWeatherForecastAsync()
				For Each item In result
					Console.WriteLine($"Date: {item.Date} F: {item.TemperatureF} C: {item.TemperatureC} Summary: {item.Summary}")
				Next item
			End Using
		End Using
	End Function

	Private Shared Function CompileCode(ByVal code As String) As System.Reflection.Assembly
		Using memoryStream As New MemoryStream()
			Dim assemblyPath = Path.GetDirectoryName(GetType(Object).Assembly.Location)
			Dim references = New List(Of MetadataReference) From {MetadataReference.CreateFromFile(GetType(Object).GetTypeInfo().Assembly.Location), MetadataReference.CreateFromFile(Path.Combine(assemblyPath, "Microsoft.AspNetCore.Mvc.dll")), MetadataReference.CreateFromFile(Path.Combine(assemblyPath, "System.Private.CoreLib.dll"))}

			Dim compilation = Microsoft.CodeAnalysis.CSharp.CSharpCompilation.Create("ApiClient").WithOptions(New Microsoft.CodeAnalysis.CSharp.CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary)).AddReferences(references).AddSyntaxTrees(Microsoft.CodeAnalysis.CSharp.SyntaxFactory.ParseSyntaxTree(code))

			Dim emitResult = compilation.Emit(memoryStream)
			If Not emitResult.Success Then
				Console.WriteLine("Compilation errors:")
				For Each diagnostic In emitResult.Diagnostics
					Console.WriteLine(diagnostic)
				Next diagnostic
				Return Nothing
			End If
			memoryStream.Seek(0, SeekOrigin.Begin)
			Return System.Reflection.Assembly.Load(memoryStream.ToArray())
		End Using
	End Function

	Public Interface IApiClient
		' Replace with your actual method name and return type
		Function GetWeatherForecastAsync() As Task(Of List(Of WeatherForecast))
	End Interface

	Public Class WeatherForecast
		Public Property [Date]() As DateTime
		Public Property TemperatureC() As Integer
		Public Property TemperatureF() As Integer
		Public Property Summary() As String
	End Class
End Class

$vbLabelText $csharpLabel

Para a API que desejamos usar, especificamos a URL da especificação Swagger (swaggerUrl). Em seguida, o código do cliente gerado e executado em um assembly DLL é definido. OpenApiDocument é empregado para carregar o documento Swagger de forma assíncrona a partir do URL fornecido, usando FromJsonAsync. Para alterar o código do cliente gerado, ajustamos as configurações do gerador de código (CSharpClientGeneratorSettings). Neste exemplo, são especificados o nome da classe e o namespace do código do cliente gerado.

A partir do documento Swagger carregado, construímos uma instância de CSharpClientGenerator e a utilizamos para gerar o código do cliente. O código do cliente criado é salvo no caminho de saída designado. Respondemos a quaisquer exceções ou erros que possam surgir durante o procedimento, exibindo as notificações relevantes no console.

NSwag C# (Como funciona para desenvolvedores): Figura 2 - Saída do console do código acima

Operação NSwag

Gerando código do cliente

O NSwag pode usar uma especificação Swagger para gerar código de cliente em várias linguagens, incluindo Java, TypeScript e C#. Isso facilita o uso de APIs pelos desenvolvedores em seus aplicativos.

Gerando código do servidor

Utilizando uma especificação Swagger como base, o NSwag também pode gerar código de servidor, como controladores ASP.NET Core . Isso ajuda a criar rapidamente a estrutura do código do lado do servidor para implementações de API.

Produzindo documentação interativa de API

Dada uma especificação Swagger, o NSwag pode gerar documentação de API interativa, como a interface de usuário Swagger UI. Esta documentação fornece uma interface fácil de usar para explorar e testar os endpoints da API.

Produzindo classes proxy

Para integrar com APIs baseadas em SOAP, o NSwag pode gerar classes proxy. Isso permite que os programadores usem o código do cliente gerado para acessar os serviços SOAP de dentro de seus aplicativos.

Verificando as especificações do Swagger

O NSwag é capaz de verificar as especificações do Swagger para garantir que elas estejam em conformidade com o padrão OpenAPI/Swagger. Isso facilita a identificação de erros ou discrepâncias na documentação da API.

Integrando o NSwag com o IronPDF

Os desenvolvedores podem melhorar o fluxo de trabalho para documentação de API, aproveitando as vantagens de ambas as tecnologias ao integrar o NSwag com o IronPDF. Os desenvolvedores podem produzir documentação completa de API web .NET , pronta para uso offline, que fica facilmente disponível e compartilhável, usando o NSwag para gerar especificações Swagger e o IronPDF para transformá-las em PDFs . Os seguintes procedimentos fazem parte do processo de integração:

O IronPDF se destaca na conversão de HTML para PDF , garantindo a preservação precisa dos layouts e estilos originais. É perfeito para criar PDFs a partir de conteúdo da web, como relatórios, faturas e documentação. Com suporte para arquivos HTML, URLs e strings HTML brutas, o IronPDF produz facilmente documentos PDF de alta qualidade.

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}

Imports IronPdf

Friend Class Program
	Shared Sub Main(ByVal args() As String)
		Dim renderer = New ChromePdfRenderer()

		' 1. Convert HTML String to PDF
		Dim htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>"
		Dim pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent)
		pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf")

		' 2. Convert HTML File to PDF
		Dim htmlFilePath = "path_to_your_html_file.html" ' Specify the path to your HTML file
		Dim pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath)
		pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf")

		' 3. Convert URL to PDF
		Dim url = "http://ironpdf.com" ' Specify the URL
		Dim pdfFromUrl = renderer.RenderUrlAsPdf(url)
		pdfFromUrl.SaveAs("URLToPDF.pdf")
	End Sub
End Class

$vbLabelText $csharpLabel

Instale o IronPDF

Inicie o projeto do Visual Studio.
Selecione "Ferramentas" > "Gerenciador de Pacotes NuGet " > "Console do Gerenciador de Pacotes".
Abra o prompt de comando e, no Console do Gerenciador de Pacotes, digite o seguinte comando:

Install-Package IronPdf

Como alternativa, você pode instalar o IronPDF usando o Gerenciador de Pacotes NuGet para Soluções.
Explore e selecione o pacote IronPDF nos resultados da pesquisa e, em seguida, clique na opção "Instalar". O Visual Studio cuidará do download e da instalação para você.

NSwag C# (Como funciona para desenvolvedores): Figura 3 - Instale o IronPDF pelo Gerenciador de Pacotes NuGet pesquisando IronPdf, selecione o projeto e clique em Instalar.

O NuGet instalará o pacote IronPDF e todas as dependências necessárias para o seu projeto.
Após a instalação, o IronPDF poderá ser utilizado em seu projeto.

Instale através do site do NuGet.

Para obter informações adicionais sobre os recursos, a compatibilidade e os downloads disponíveis do IronPDF, visite a página do IronPDF no NuGet .

Utilize DLL para instalar

Alternativamente, você pode incorporar o IronPDF diretamente em seu projeto usando seu arquivo DLL. Para baixar o arquivo ZIP contendo a DLL, clique no link de download do IronPDF . Descompacte o arquivo e adicione a DLL ao seu projeto.

Implementando a lógica

Ao utilizar o NSwag, os desenvolvedores podem criar documentação de API e código de cliente para usar APIs mais rapidamente usando CodeGeneration.CSharp em conjunto com o IronPDF. Os seguintes passos fazem parte do fluxo de trabalho de integração:

Gerar código do cliente: Para criar código de cliente C# a partir de especificações Swagger, use NSwag.CodeGeneration.CSharp. Nesta etapa, a criação de classes e métodos de cliente para comunicação com os endpoints da API é automatizada.
Utilize NSwag para obter dados: Para produzir documentação JSON a partir de especificações Swagger, use CodeGeneration.CSharp. Nesta etapa, os formatos de solicitação/resposta, as técnicas de autenticação e os endpoints do cliente da API são transformados em documentação legível para humanos.
Converter JSON para PDF: Para converter o código gerado em um documento PDF, use o IronPDF. Nesta etapa, o texto HTML é convertido em um documento PDF refinado, pronto para compartilhamento e distribuição.
Aprimore a documentação em PDF: Adicione mais conteúdo à documentação em PDF usando o IronPDF, como cabeçalhos, rodapés, marcas d'água ou identidade visual exclusiva. Esta etapa oferece aos desenvolvedores a possibilidade de personalizar a aparência e a identidade visual da documentação em PDF de acordo com suas preferências.

using IronPdf;
using System.Text;
using System.Collections.Generic;

StringBuilder sb = new StringBuilder();

foreach (var item in result)
{
    sb.Append($"<p>Date: {item.Date} F: {item.TemperatureF} C: {item.TemperatureC} Summary: {item.Summary}</p>");
}

var renderer = new HtmlToPdf();
var pdf = renderer.RenderHtmlAsPdf(sb.ToString());
pdf.SaveAs("output.pdf");
Console.WriteLine("PDF generated successfully!");
Console.ReadKey();

using IronPdf;
using System.Text;
using System.Collections.Generic;

StringBuilder sb = new StringBuilder();

foreach (var item in result)
{
    sb.Append($"<p>Date: {item.Date} F: {item.TemperatureF} C: {item.TemperatureC} Summary: {item.Summary}</p>");
}

var renderer = new HtmlToPdf();
var pdf = renderer.RenderHtmlAsPdf(sb.ToString());
pdf.SaveAs("output.pdf");
Console.WriteLine("PDF generated successfully!");
Console.ReadKey();

Imports IronPdf
Imports System.Text
Imports System.Collections.Generic

Private sb As New StringBuilder()

For Each item In result
	sb.Append($"<p>Date: {item.Date} F: {item.TemperatureF} C: {item.TemperatureC} Summary: {item.Summary}</p>")
Next item

Dim renderer = New HtmlToPdf()
Dim pdf = renderer.RenderHtmlAsPdf(sb.ToString())
pdf.SaveAs("output.pdf")
Console.WriteLine("PDF generated successfully!")
Console.ReadKey()

$vbLabelText $csharpLabel

O código acima acessa os dados recuperados do objeto de resultado e anexa os campos Date, TemperatureF, TemperatureC e Summary aos parágrafos em um loop. Em seguida, especifica o caminho do arquivo PDF de saída e notifica o usuário de que um PDF foi gerado com sucesso.

Abaixo está o resultado do código acima.

NSwag C# (Como funciona para desenvolvedores): Figura 4 - Exemplo de saída do código acima

Conclusão

Tecnologias NSwag como CodeGeneration e IronPDF funcionam bem juntas para agilizar os processos de produção de código do cliente e documentação de API. Os desenvolvedores podem acelerar a criação de soluções orientadas a APIs, automatizar a criação de documentação de APIs e produzir publicações em PDF com aparência profissional, integrando essas ferramentas em aplicativos C#. NSwag.CodeGeneration.CSharp com IronPDF oferece aos desenvolvedores uma solução completa para documentar APIs e produzir código cliente em C# de forma eficiente, seja para desenvolvimento de aplicativos desktop, web ou em nuvem.

O pacote Lite inclui uma licença perpétua, um ano de manutenção do software e uma atualização da biblioteca. O IronPDF oferece licença gratuita com restrições de redistribuição e tempo. Os usuários podem avaliar a solução durante o período de teste sem precisar ver uma marca d'água. Para obter informações adicionais sobre preço e licença, consulte as informações de licenciamento do IronPDF . Acesse a página de bibliotecas da Iron Software para obter informações adicionais sobre as bibliotecas de produtos da Iron Software.

Perguntas frequentes

Como o NSwag pode ajudar na geração de especificações de API em C#?

O NSwag pode gerar automaticamente especificações de API, conhecidas como documentos Swagger ou OpenAPI, a partir de projetos .NET Core. Isso garante que a documentação da API esteja sempre sincronizada com a base de código.

Qual é o processo para converter especificações Swagger em documentos PDF?

Para converter especificações Swagger em documentos PDF, você pode usar o IronPDF. Primeiro, gere a especificação Swagger usando o NSwag e, em seguida, utilize o IronPDF para converter o conteúdo HTML dessas especificações em PDFs de alta qualidade.

Como posso integrar o NSwag em um projeto .NET?

A integração do NSwag em um projeto .NET envolve a instalação da biblioteca NSwag via NuGet, a configuração para gerar especificações Swagger durante o processo de compilação e o uso das especificações geradas para documentação e geração de código.

O NSwag consegue gerar código tanto para o cliente quanto para o servidor a partir de uma especificação Swagger?

Sim, o NSwag pode gerar código do lado do cliente em linguagens como C#, Java e TypeScript, bem como código do lado do servidor, como controladores ASP.NET Core, tudo a partir de uma única especificação Swagger.

Como o IronPDF aprimora o fluxo de trabalho de documentação de API?

O IronPDF aprimora o fluxo de trabalho de documentação de API, permitindo que os desenvolvedores convertam documentação de API baseada em HTML em documentos PDF profissionais e compartilháveis, tornando as informações acessíveis offline.

Quais são os passos necessários para usar o IronPDF em um projeto do Visual Studio?

Para usar o IronPDF em um projeto do Visual Studio, instale-o através do Gerenciador de Pacotes NuGet, pesquisando por IronPDF e clicando em 'Instalar', ou use o Console do Gerenciador de Pacotes com o comando Install-Package IronPDF .

Como gerar documentação de API interativa usando o NSwag?

O NSwag pode gerar documentação de API interativa, produzindo uma interface de usuário Swagger, que fornece uma interface amigável para explorar e testar endpoints de API diretamente no navegador.

Quais são os benefícios de usar o NSwag para documentação de API?

O NSwag automatiza a geração de documentação de API, garantindo que ela esteja sempre atualizada com a base de código. Ele também oferece suporte à criação de documentação interativa e código do lado do cliente, agilizando o processo de desenvolvimento.

Como o IronPDF funciona com conteúdo HTML para criar PDFs?

O IronPDF converte conteúdo HTML, incluindo CSS e JavaScript, em formato PDF usando seu mecanismo de renderização, tornando-o ideal para criar documentos precisos e prontos para uso offline a partir de conteúdo da web.

Curtis Chau

Converse agora mesmo com a equipe de engenharia.

Redator Técnico

Curtis Chau é bacharel em Ciência da Computação (Universidade Carleton) e se especializa em desenvolvimento front-end, com experiência em Node.js, TypeScript, JavaScript e React. Apaixonado por criar interfaces de usuário intuitivas e esteticamente agradáveis, Curtis gosta de trabalhar com frameworks modernos e criar manuais ...

Destaque do cliente:

Destaque do desenvolvedor:

Webinários:

Experimente gratuitamente por 30 dias.

Nswag C# (Como funciona para desenvolvedores)

Como usar o NSwag em C

Entendendo o NSwag

Características do NSwag

Produção de especificações Swagger

Conectividade com projetos .NET

Personalização e Expansão

Primeiros passos com o NSwag

Configurando o NSwag em um aplicativo de console C

Implementando NSwag no Console e no Windows Forms

Exemplo NSwag em C

Operação NSwag

Gerando código do cliente

Gerando código do servidor

Produzindo documentação interativa de API

Produzindo classes proxy

Verificando as especificações do Swagger

Integrando o NSwag com o IronPDF

Instale o IronPDF

Instale através do site do NuGet.

Utilize DLL para instalar

Implementando a lógica

Conclusão

Perguntas frequentes

Como o NSwag pode ajudar na geração de especificações de API em C#?

Qual é o processo para converter especificações Swagger em documentos PDF?

Como posso integrar o NSwag em um projeto .NET?

O NSwag consegue gerar código tanto para o cliente quanto para o servidor a partir de uma especificação Swagger?

Como o IronPDF aprimora o fluxo de trabalho de documentação de API?

Quais são os passos necessários para usar o IronPDF em um projeto do Visual Studio?

Como gerar documentação de API interativa usando o NSwag?

Quais são os benefícios de usar o NSwag para documentação de API?

Como o IronPDF funciona com conteúdo HTML para criar PDFs?

Equipe de suporte de ferro

Experimente gratuitamente por 30 dias.

Nswag C# (Como funciona para desenvolvedores)

Como usar o NSwag em C

Entendendo o NSwag

Características do NSwag

Produção de especificações Swagger

Conectividade com projetos .NET

Personalização e Expansão

Primeiros passos com o NSwag

Configurando o NSwag em um aplicativo de console C

Implementando NSwag no Console e no Windows Forms

Exemplo NSwag em C

Operação NSwag

Gerando código do cliente

Gerando código do servidor

Produzindo documentação interativa de API

Produzindo classes proxy

Verificando as especificações do Swagger

Integrando o NSwag com o IronPDF

Instale o IronPDF

Instale através do site do NuGet.

Utilize DLL para instalar

Implementando a lógica

Conclusão

Perguntas frequentes

Como o NSwag pode ajudar na geração de especificações de API em C#?

Qual é o processo para converter especificações Swagger em documentos PDF?

Como posso integrar o NSwag em um projeto .NET?

O NSwag consegue gerar código tanto para o cliente quanto para o servidor a partir de uma especificação Swagger?

Como o IronPDF aprimora o fluxo de trabalho de documentação de API?

Quais são os passos necessários para usar o IronPDF em um projeto do Visual Studio?

Como gerar documentação de API interativa usando o NSwag?

Quais são os benefícios de usar o NSwag para documentação de API?

Como o IronPDF funciona com conteúdo HTML para criar PDFs?

Artigos relacionados

Unindo a simplicidade da linha de comando e o .NET: usando Curl DotNet com IronPDF

Gerador de Números Aleatórios em C#

O operador Equals em C# (Como funciona para desenvolvedores)

Want to deploy IronSuite to a live project for FREE?

What’s included?

Thank You

Want to deploy IronSuite to a live project for FREE?

What’s included?

Aprovado por milhões de engenheiros em todo o mundo.

Equipe de suporte de ferro