<meter id="7ntxv"></meter>

<b id="7ntxv"><listing id="7ntxv"><ol id="7ntxv"></ol></listing></b>
<nobr id="7ntxv"></nobr><mark id="7ntxv"></mark>

    <p id="7ntxv"><menuitem id="7ntxv"><font id="7ntxv"></font></menuitem></p>
    <sub id="7ntxv"><menuitem id="7ntxv"><meter id="7ntxv"></meter></menuitem></sub>

    <mark id="7ntxv"></mark>
    <meter id="7ntxv"><var id="7ntxv"></var></meter>

    知識 分享 互助 懶人建站

      懶人建站專注于網頁素材下載,提供網站模板、網頁設計、ps素材、圖片素材等,服務于【個人站長】【網頁設計師】和【web開發從業者】的代碼素材與設計素材網站。

      懶人建站提供網頁素材下載、網站模板
      知識 分享 互助!

      ApiDoc(通過代碼中的注釋生成Api文檔)使用教程

      作者:不吃魚的貓 2022-11-13 人氣:
      ApiDoc簡明使用教程,ApiDoc是一個通過代碼中的注釋生成Api文檔的js插件,全局安裝APIDOC,配置一個 apidoc.json 文件,配置package.json 添加ApiDoc快捷執行命令

      1.全局安裝APIDOC

      需要nodejs環境,在項目目錄下面使用 npm 安裝

       npm install apidoc -g

      2.配置一個 apidoc.json 文件,內容如下:

      {
      "name": "懶人建站",
      "version": "1.0.0",
      "description": "懶人建站 Api文檔",
      "title": "懶人建站API V1",
      "url" : "http://127.0.0.1:20221/v1",
      "sampleUrl" : "http://127.0.0.1:20221/v1"
      }

      3.配置package.json 添加ApiDoc快捷執行命令

      "doc": "apidoc -i app -o apidoc"

      {"name": "api","version": "0.1.0","private": true,"scripts": {"doc": "apidoc -i app -o apidoc"}}

      注:apidoc -i app -o apidoc 要生成api的文件夾(可以是絕對地址) apidoc是api輸出文件夾

      4.添加注釋,參數解釋 參考:

      https://apidocjs.com/

      5.執行第三步的命令即可生成 api 文檔

      npm run

      注釋示例:

      /**
      * @api {get} /details/:Id 獲取用戶詳情
      * @apiName GetUserDetails
      * @apiGroup 會員模塊
      * @apiParam {Number} Id Users unique ID.
      * @apiSuccess {String} firstname Firstname of the User.
      * @apiSuccess {String} lastname Lastname of the User.
      * @apiSuccessExample Success-Response:
      * HTTP/1.1 200 OK
      * {
      * "firstname": "懶人建站",
      * "lastname": "Doe1"
      * }
      *
      * @apiError UserNotFound The id of the User was not found.
      * @apiErrorExample Error-Response:
      * HTTP/1.1 404 Not Found
      * {
      * "error": "UserNotFound"
      * }
      */
      ↓ 查看全文

      ApiDoc(通過代碼中的注釋生成Api文檔)使用教程由懶人建站收集整理,您可以自由傳播,請主動帶上本文鏈接

      懶人建站就是免費分享,覺得有用就多來支持一下,沒有能幫到您,懶人也只能表示遺憾,希望有一天能幫到您。

      ApiDoc(通過代碼中的注釋生成Api文檔)使用教程-最新評論

      亚洲免费的黄色网站_黄色网站在线放久操射视频_A片www.黄色网站成年人_天天干 天天操天天干

      <meter id="7ntxv"></meter>

      <b id="7ntxv"><listing id="7ntxv"><ol id="7ntxv"></ol></listing></b>
      <nobr id="7ntxv"></nobr><mark id="7ntxv"></mark>

        <p id="7ntxv"><menuitem id="7ntxv"><font id="7ntxv"></font></menuitem></p>
        <sub id="7ntxv"><menuitem id="7ntxv"><meter id="7ntxv"></meter></menuitem></sub>

        <mark id="7ntxv"></mark>
        <meter id="7ntxv"><var id="7ntxv"></var></meter>