From 10e303aaa195e6f1547633bc3c4bd1c1e9dd6c7d Mon Sep 17 00:00:00 2001 From: Huang Xueyuan Date: Thu, 2 Jun 2016 16:23:00 +0800 Subject: [PATCH] Rest api - add samples for tags and overwrite doc (#5) --- articles/docfx_getting_started.md | 2 +- restapi/petstore.swagger.json | 8 +++++--- specs/Cat.md | 4 ++-- specs/petstore-operations.md | 13 +++++++++++++ 4 files changed, 21 insertions(+), 6 deletions(-) diff --git a/articles/docfx_getting_started.md b/articles/docfx_getting_started.md index 20d5262..da3ba3f 100644 --- a/articles/docfx_getting_started.md +++ b/articles/docfx_getting_started.md @@ -6,7 +6,7 @@ Getting Started This is a seed. ![Seed](images/seed.jpg) -`docfx` is an API documentation generator for .NET, currently support C# and VB. It has the ability to extract triple slash comments out from your source code. What's more, it has syntax to link additional files to API to add additional remarks. `docfx` will scan your source code and your additional conceptual files and generate a complete HTML documentation website for you. `docfx` provides the flexibility for you to customize the website through templates. We currently have several embeded templates, including websites containing pure static html pages and also website managed by AngularJS. +`docfx` is an API documentation generator for .NET, currently support C# and VB. It has the ability to extract triple slash comments out from your source code. What's more, it has syntax to link additional files to API to add additional remarks. `docfx` will scan your source code and your additional conceptual files and generate a complete HTML documentation website for you. `docfx` provides the flexibility for you to customize the website through templates. We currently have several embedded templates, including websites containing pure static html pages and also website managed by AngularJS. * Click "View Source" for an API to route to the source code in GitHub (your API must be pushed to GitHub) * `docfx` provide DNX version for cross platform use. diff --git a/restapi/petstore.swagger.json b/restapi/petstore.swagger.json index d078e75..a5f980e 100644 --- a/restapi/petstore.swagger.json +++ b/restapi/petstore.swagger.json @@ -228,7 +228,8 @@ ], "summary": "Add a new pet to the store", "tags": [ - "pet" + "pet", + "store" ] }, "put": { @@ -985,7 +986,7 @@ }, "summary": "Updated user", "tags": [ - "user" + "unknown" ] } } @@ -1012,7 +1013,8 @@ "swagger": "2.0", "tags": [ { - "description": "Everything about your Pets", + "description": "Everything about your **Pets**", + "x-bookmark-id": "EverythingAboutYourPets", "externalDocs": { "description": "Find out more", "url": "http://swagger.io" diff --git a/specs/Cat.md b/specs/Cat.md index 914d646..25e9fc7 100644 --- a/specs/Cat.md +++ b/specs/Cat.md @@ -1,6 +1,6 @@ --- uid: CatLibrary.Cat`2 -remarks: '*THIS* is remarks overriden in *MARKDWON* file' +remarks: '*THIS* is remarks overridden in *MARKDWON* file' --- This is a class talking about [CAT](https://en.wikipedia.org/wiki/Cat). @@ -13,7 +13,7 @@ Refer to @CatLibrary.IAnimal to see other animals. --- uid: CatLibrary.IAnimal -remarks: '*THIS* is remarks overriden in *MARKDWON* file' +remarks: '*THIS* is remarks overridden in *MARKDWON* file' --- ### Welcome to the **Animal** world! diff --git a/specs/petstore-operations.md b/specs/petstore-operations.md index 8966b35..deda76f 100644 --- a/specs/petstore-operations.md +++ b/specs/petstore-operations.md @@ -21,3 +21,16 @@ uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0/addPet footer: *content --- > NOTE: Add pet only when you needs. + +--- +uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0/tag/pet +description: *content +--- + +Description for pet tag + +--- +uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0/tag/store +--- + +Additional description for store tag \ No newline at end of file