Este artigo é um artigo espelhado de tradução automática, por favor clique aqui para ir para o artigo original.

Vista: 20232|Resposta: 0

[WebAPI] A webAPI gera automaticamente documentação de ajuda

[Copiar link]
Publicado em 06/10/2016 15:08:16 | | | |
Anteriormente, eu usava o webapi para fornecer interfaces no projeto, e descobri que no projeto há geração automática de documentos de ajuda de acordo com métodos e comentários do webapi, e você também pode testar métodos webapi, que são muito poderosos, e agora vou compartilhá-los com você.
Dê uma olhada na documentação gerada do webapi primeiro.
1. A figura a seguir mostra a página superior do documento de ajuda de geração, onde Values é o controlador, e a lista abaixo da API mostra o método http (Get, POST, etc.), a ação da solicitação e a descrição do método.
2. Clique no link na caixa vermelha para abrir a página de detalhes do método API, conforme mostrado na figura abaixo.
3. Clique na API de Teste para abrir a página a seguir

4. Insira os parâmetros, clique no botão Enviar, abra a página seguinte e você poderá ver o valor de retorno.

Os passos para configurá-lo são os seguintes:
Ambiente de desenvolvimento VS2012 + MVC4 + API WEB
1. Referenciar o Cliente de Teste da Web API através do NuGet

Referenciar a DLL gerará um arquivo assim:
Esta é a nossa interface de documentação de ajuda


2. Faça as seguintes configurações nas propriedades do projeto, verifique o arquivo do documento XMl e defina o caminho
3. Crie um XmlDocument.xml na pasta App_Data do projeto
4. Abra o arquivo AreasHelpPageApp_StartHelpPageConfig.cs e cancele os comentários de código a seguir

Execute o projeto, abra a http://localhost:3619/Help e você verá o documento da API gerado automaticamente, que é uma imagem do artigo

Download do Projeto:

WebAPIHelper.part2.rar (893.15 KB, Número de downloads: 1) WebAPIHelper.part1.rar (1.5 MB, Número de downloads: 0)




Anterior:ss-panel v3 rodando o erro de servers.py em Python
Próximo:Bloqueie o clique direito em F12 e evite visualizar o código-fonte
Disclaimer:
Todo software, material de programação ou artigos publicados pela Code Farmer Network são apenas para fins de aprendizado e pesquisa; O conteúdo acima não deve ser usado para fins comerciais ou ilegais, caso contrário, os usuários terão todas as consequências. As informações deste site vêm da Internet, e disputas de direitos autorais não têm nada a ver com este site. Você deve deletar completamente o conteúdo acima do seu computador em até 24 horas após o download. Se você gosta do programa, por favor, apoie um software genuíno, compre o registro e obtenha serviços genuínos melhores. Se houver qualquer infração, por favor, entre em contato conosco por e-mail.

Mail To:help@itsvse.com