3 ス テ ッ プ で WebAPI ド キ ュ メ ン ト を 作 る.

Microsoft.AspNet.WebApi.HelpPageの API ヘ ル プ ペ ー ジ に は ド キ ュ メ ン ト 作成 に に 関 す る 情報 は あ り ま せ ん。 下 記 の よ う に に 作成 に 関 す る 情報 は あ り ま せ ん。 下 記 の よ う に Controlador ア ク シ ョ ン Controlador 使 Controller シ ョ ュ ュ

ド キ ュ メ ン ン ト 化 を 有効 化 す る に は 、 下 記 の 簡 単 な ス テ ッ プ を 踏 め ば 直 ぐ に 対 応 で き ま す。

Passo 1- コ ン ト ロ ー ラ ー レ ベ ル

テ ス ト 目的 で 、 DocumentationsController と い う 名 前 で 新 し い ApiController を 作成 し ま す.

 public class DocumentationsController : ApiController
{
    // GET api/documentation
    public IEnumerable<string> Get()
    {
        return new string[] { "value1", "value2" };
    }
....

ド キ ュ メ メ ン ト 化 を す る 対 対 象 と る る コ ン ト ロ ー ラ ー ア ク シ ョ ン の 前 に /// を 入 れ ま す。

// GET api/documentation
/// <summary>
/// This is how we create a documentation
/// </summary>
/// <returns></returns>
public IEnumerable<string> Get()
....

な に が ド キ ュ メ ン ト 化 さ れ た か 確認 す る に は 、 ”<” を 打 つ と IntelliSense が 表示 さ れ る か 、 [ https://msdn.microsoft.com/en-us/library/b2s página ,( DNs063f7.aspx .) に 飛 ば さ れ ま す。

Etapa 2- プ ロ パ テ ィ の 作成

プ ロ ジ ェ ク ト プ ロ パ テ ィ ペ ー ジ を 開 き, ド キ ュ メ ン ト 化 す る た め に xml ア ウ チ プ ッ ト の 設定 を し ま す. こ の 例 で は, ド キ ュ メ ン テ ー シ ョ ン フ ァ イ ル は App_Data Documentation.XML. の よ う に な り ま す.

Passo 3 – ヘ ル プ ペ ー ジ の 設定

ド キ ュ メ ン テ ー シ ョ ン の xml フ ァ イ ル を 使 う た め の HelpPageConfig の 設定 は 、 ~ Areas HelpPage HelpPageConfig.cs. に て 行 い ま す。

デ フ ォ ル ト 設定 で 、 config.SetDocumentationProvider ス テ 0 ト メ ン ト は コ メ ン ン ト ア ウ ト さ れ れ て い ま す。 こ の ス テ ー ト メ ン ト ト を 用 ト メ メ ン ト ア ウ ト さ れ れ て い ま す。 こ の ス テ ー ト メ ン ト ト を 用 い ider ider ider

public static void Register(HttpConfiguration config)
{
    // Uncomment the following to use the documentation from XML documentation file.
    config.SetDocumentationProvider(
        new XmlDocumentationProvider(
            HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml")));

API ド キ ュ メ ン ト の ペ ー ジ を リ ロ ー ド す る と:

ド キ ュ メ ン ト フ ァ イ ル の 作成 が で き ま し た。

こ れ に て 完了 で す。