Documentando um serviço WCF REST

Você está implementando um serviço WCF Rest e precisa documentar suas API´s? utilize o projeto open source AUTODOCS – https://autodocs.codeplex.com/.

Para usar basta fazer o download da biblioteca e referenciar no seu projeto WCF REST e anotar sua interface e seus métodos da seguinte forma:

Na interface:

[ServiceContract]
 [WebServiceDoc(Title = "Client REST API Documentation - Example",
 Description = "Web Services API for user management in the foo system.",
 SupportLink = "mailto:seu email")]
 public interface IClientR

No método:

[OperationContract]
 [WebGet(ResponseFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped, 
 UriTemplate = "SearchAll")]
 [WebOperationDoc(Description ="Update an existing user in the system. If UserId is invalid, 
 null or doesn't exist it throws HTTP 404 - Not found.")]
 SearchClientResponse SearchAll();

Para verificar a documentação basta acessar:

http://endereçodoseuserviço/Client.svc/rest/SearchAll/docs

Pronto sua API está devidamente documentada.

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *