Come posso ottenere un elenco di metodi disponibili in un servizio Web WebAPI?

Question

Sto costruendo un piccolo strumento di test che dovrebbe fornire all'utente un elenco di servizi Web (creati utilizzando WebAPI). L'utente dovrebbe essere in grado di scegliere un servizio da testare. Sto usando

HttpClient client = new HttpClient(); 
client.BaseAddress = new Uri("http://'localhost':51062/"); 

// Add an Accept header for JSON format. 

client.DefaultRequestHeaders.Accept.Add(
       new MediaTypeWithQualityHeaderValue("application/json")); 

e sto cercando qualcosa di simile

client.GetAllWebServices() 

che restituire un elenco di metodi che l'utente può vedere. Significato, i metodi che ha sviluppato sul controller e vuole testare.

Answer 1

Michael ha ragione a dire ApiExplorer. Questo ti fornisce i dettagli di tutti i metodi WebApi per te. Hai solo bisogno di formattarlo come vuoi la risposta.

Ecco un semplice esempio per ottenere un elenco di tutti i metodi con i relativi parametri e tipi di ritorno. Ovviamente si può rendere questo molto più completo - basta sfogliare gli oggetti per trovare ciò che serve:

using System.Collections.Generic; 
using System.Linq; 
using System.Web.Http; 
using System.Web.Http.Description; 

namespace WebApplication1.Controllers 
{ 
    public class ApiMethodController : ApiController 
    { 
     public IEnumerable<HelpMethod> GetMethods() 
     { 
      // get the IApiExplorer registered automatically 
      IApiExplorer ex = this.Configuration.Services.GetApiExplorer(); 

      // loop, convert and return all descriptions 
      return ex.ApiDescriptions 
       // ignore self 
       .Where(d => d.ActionDescriptor.ControllerDescriptor.ControllerName != "ApiMethod") 
       .Select(d => 
       { 
        // convert to a serializable structure 
        return new HelpMethod 
        { 
         Parameters = d.ParameterDescriptions.Select(p => new HelpParameter 
         { 
          Name = p.Name, 
          Type = p.ParameterDescriptor.ParameterType.FullName, 
          IsOptional = p.ParameterDescriptor.IsOptional 
         }).ToArray(), 
         Method = d.HttpMethod.ToString(), 
         RelativePath = d.RelativePath, 
         ReturnType = d.ResponseDescription.DeclaredType == null ? 
          null : d.ResponseDescription.DeclaredType.ToString() 
        }; 
       }); 
     } 
    } 

    public class HelpMethod 
    { 
     public string Method { get; set; } 
     public string RelativePath { get; set; } 
     public string ReturnType { get; set; } 
     public IEnumerable<HelpParameter> Parameters { get; set; } 
    } 

    public class HelpParameter 
    { 
     public string Name { get; set; } 
     public string Type { get; set; } 
     public bool IsOptional { get; set; } 
    } 
} 

La cosa bella è che si tratta di un WebAPI stessa chiamata, in modo da poter utilizzare il HttpClient per chiamare ed elaborarlo utilizzando http://www.localhost.com/api/ApiMethod/Methods. Ecco la risposta del campione JSON:

[ 
    { 
     "Method": "GET", 
     "RelativePath": "api/Account/{id}", 
     "ReturnType": "WebApplication1.Models.Account", 
     "Parameters": [ 
      { 
       "Name": "id", 
       "Type": "System.Int32", 
       "IsOptional": false 
      } 
     ] 
    }, 
    { 
     "Method": "POST", 
     "RelativePath": "api/Account", 
     "ReturnType": null, 
     "Parameters": [ 
      { 
       "Name": "a", 
       "Type": "WebApplication1.Models.Account", 
       "IsOptional": false 
      } 
     ] 
    }, 
    { 
     "Method": "GET", 
     "RelativePath": "api/Maths?i={i}&j={j}", 
     "ReturnType": "System.Int32", 
     "Parameters": [ 
      { 
       "Name": "i", 
       "Type": "System.Int32", 
       "IsOptional": false 
      }, 
      { 
       "Name": "j", 
       "Type": "System.Int32", 
       "IsOptional": false 
      } 
     ] 
    } 
] 

Andando avanti

Ottenere doc XML commenta fuori non è così netta, ma c'è un tutorial su MSDN Blogs.

Inoltre, ci sono altri pacchetti disponibili che è possibile utilizzare, collegare in, rubare, che fanno simile a ciò che è necessario, per esempio

• Swagger.Net
• RAML

Altro dettagli su questi in VS Mag