2017-09-27 18 views
0

生成されたswagger.jsonファイルには、オーバーライドしたメソッドのXMLインラインコメントは含まれていません。他のすべてのメソッドの場合、インラインコメントは生成されたswagger.jsonに含まれます。 xmlファイルには、ファイルが正しいようにすべてのコメントが含まれています。すべてのルートが正常に動作しています。XMLインラインコメントは生成されたswagger.jsonに含まれていません

生成されたswagger.jsonにすべてのXMLコメントが含まれているのはなぜですか?

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; 

そして私によってCreatePetsを上書き:あなたはPOST操作はいずれかを持っていない見ることができるように闊歩UIでの結果は、この、 Swagger UI

のようになります

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

コメント、なぜですか?

XMLファイルはしかし、それらを含め、XML file

+0

StartUp.csからSwagger設定を投稿してください。あなたは実際にあなたがやっていないXMLファイルを使用するようにSwaggerに伝える必要があります。 –

+0

あなたのケースのコメントは、親からではなくTestOfPets.CreatePetsから来て、確認するために生成されたXMLファイルをチェックしてください – HelderSepu

答えて

0

startUp.csは、この構成のものが含まれます。

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

controllapi.xmlはTestOfPetsに関連するものが含まれていません。 PetsApiController.CreatePetsのみが含まれます。

関連する問題