2017-09-27 4 views
0

Le fichier swagger.json généré n'inclut pas les commentaires en ligne XML pour les méthodes que j'ai remplacées. Pour toutes les autres méthodes, les commentaires en ligne sont inclus dans le fichier swagger.json généré. Le fichier xml inclut tous les commentaires afin que le fichier semble être correct. Toutes les routes fonctionnent comme elles le devraient.Les commentaires en ligne XML ne sont pas inclus dans le swagger.json généré

Pourquoi tous les commentaires XML ne sont-ils pas inclus dans le fichier swagger.json généré?

PetsApi.cs 
    public abstract class PetsApiController : Controller 
    { 

    /// <summary> 
    /// Create a pet. 27th of Sept 
    /// </summary> 

    /// <response code="201">Null response</response> 
    /// <response code="0">unexpected error</response> 
    [HttpPost] 
    [Route("/v1/pets")] 
    [SwaggerOperation("CreatePets")] 
    public virtual void CreatePets() 
    { 
     throw new NotImplementedException(); 
    } 


    /// <summary> 
    /// List all pets. 27th of Sept 
    /// </summary> 

    /// <param name="limit">How many items to return at one time (max 100)</param> 
    /// <response code="200">An paged array of pets</response> 
    /// <response code="0">unexpected error</response> 
    [HttpGet] 
    [Route("/v1/pets")] 
    [SwaggerOperation("ListPets")] 
    [SwaggerResponse(200, type: typeof(Pets))] 
    public virtual IActionResult ListPets([FromQuery]int? limit) 
    { 
     string exampleJson = null; 

Et puis-je remplacer CreatePets par:

public class TestOfPets : Controllers.PetsApiController 
{ 
    public override void CreatePets() 
    { 
     int testing; 

Le résultat dans l'interface utilisateur Swagger sera alors comme ça, Swagger UI

Comme vous pouvez le voir l'opération POST ne pas de commentaires, pourquoi?

Le fichier XML les comprennent bien, XML file

+0

Postez votre configuration Swagger à partir de StartUp.cs. Vous devez dire à Swagger d'utiliser le fichier XML, ce que vous ne faites probablement pas. –

+0

Les commentaires dans votre cas proviennent de TestOfPets.CreatePets ne proviennent pas du parent, vérifiez le fichier XML généré pour confirmer – HelderSepu

Répondre

0

Les startUp.cs comprennent cette configuration:

  var basePath = PlatformServices.Default.Application.ApplicationBasePath; 
      var xmlPath = Path.Combine(basePath, "controllapi.xml"); 
      myData.IncludeXmlComments(xmlPath) 

Les controllapi.xml ne comprennent pas tout ce qui concerne TestOfPets. Il inclut seulement PetsApiController.CreatePets.