介面文件自動生成、使用apidoc 生成Restful web Api文件(express)
專案地址為:
專案地址
這個是自動生成網頁,我們就可以擺脫excel。
一.首先是使用node安裝apiDoc
npm install apidoc -g
二.在需要生成介面的添加註釋
/**
* @api {post} /v1/login 使用者登入
* @apiDescription 使用者登入
* @apiName login
* @apiGroup User
* @apiParam {string} username 使用者名稱
* @apiParam {string} password 密碼
* @apiSuccess token 返回token
* @apiSuccessExample {json} Success-Response:
* {"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImhleGlhbmd5dSIsImV4cCI6MT
* UyNjk3MzYwNSwiaWF0IjoxNTI2MzY4ODA1fQ.mvxQV2v7Wsyd_geZC6WqgZgb8WyUdh8M_G-Rpe6HrP4"}
* @apiSampleRequest http://localhost:3001/v1/login
* @apiVersion 1.0.0
*/
/**
* @api {post} /v1/user 獲取使用者資訊
* @apiDescription 獲取使用者資訊
* @apiName user
* @apiGroup User
* @apiParam {string} username 使用者名稱
* @apiParam {string} age 年齡
* @apiParam {string} token 簽名
* @apiSuccess token 返回token
* @apiSuccessExample {json} Success-Response:
* {"token":""}
* @apiSampleRequest http://localhost:3001/v1/user
* @apiVersion 1.0.0
*/
三.專案目錄配置建立apidoc.json檔案
{
"name": "cloud-server",
"version": "1.0.0",
"description": "cloud-server專案API文件",
"title": "cloud-server API",
"url": "http://localhost:3030/v1",
"forceLanguage": "zh-cn"
}
或者在package.json檔案中加
,
"apidoc": {
"name": "cloud-server",
"version": "1.0.0",
"description": "cloud-server專案API文件",
"title": "cloud-server API",
"url": "http://localhost:3030/v1",
"forceLanguage": "zh-cn"
}
name:專案名稱
version:專案版本
description:專案介紹
title:瀏覽器顯示的標題內容
url:endpoints的字首,例如https://api.github.com/v1
sampleUrl:如果設定了,則在api文件中出現一個測試用的from表單
header
title:導航文字包含header.md檔案
filename:markdown-file 檔名
footer
title:導航文字包含header.md檔案
filename:markdown-file 檔名
order:用於配置輸出 api-names/group-names 排序,在列表中的將按照列表中的順序排序,不在列表中的名稱將自動顯示。
四.使用命令生成專案目錄中介面的目錄是routes,生成的今天網頁我是放在了public/apidoc下
apidoc -i ./routes/ -o ./public/apidoc
var token = req.body.token || req.query.token || req.headers['x-access-token'];
相關推薦
介面文件自動生成、使用apidoc 生成Restful web Api文件(express)
專案地址為: 專案地址 這個是自動生成網頁,我們就可以擺脫excel。 一.首先是使用node安裝apiDoc npm install apidoc -g 二.在需要生成介面的添加註釋 /** * @api {post} /v1/login
使用apidoc 生成Restful web Api文件
在專案開發過程中,總會牽扯到介面文件的設計與編寫,之前使用的都是office工具,寫一個文件,總也是不夠漂亮和直觀。好在git上的開源大神提供了生成文件的工具,so來介紹一下! 該工具是Nodejs的模組,請務必在使用前安裝好nodejs環境! 工具名稱:apiDoc Git地址:http
SpringBoot(二十)Swagger2-自動生成RESTful規範API文件
Swagger2 方式,一定會讓你有不一樣的開發體驗:功能豐富 :支援多種註解,自動生成介面文件介面,支援在介面測試API介面功能;及時更新 :開發過程中花一點寫註釋的時間,就可以及時的更新API文件,省心省力;整合簡單 :通過新增pom依賴和簡單配置,內嵌於應用中就可同時釋
SpringBoot中使用Swagger生成RestFul規範API文件
j簡單介紹Swagger的作用: Swagger是為了描述一套標準的而且是和語言無關的REST API的規範。對於外部呼叫者來說,只需通過Swagger文件即可清楚Server端提供的服務,而不需去閱讀原始碼或介面文件說明。 官方網站為:http://swagger.io 中文網站:http
nodejs restful 的api文件生成
1、apidoc的官網 http://apidocjs.com 2、安裝nodejs環境,安裝apidoc npm install apidoc -g 3、在專案根目錄建立:apidoc.json;如: { "name": "
Android 自動編譯、打包生成apk檔案 1
一、搭建搭建環境 1. 安裝JDK 和 Android SDK 2. 配置環境變數D:\android-sdk-windows\toolsC:\Program Files\Java\jdk
rsync文件同步工具介紹、常用選項及rsync通過ssh同步 (一)
20180514一、rsync工具介紹(文件同步工具)1?實現a目錄保存到b目錄下,但是a目錄的數據一直在更新。用cp命令很浪費時間。這時我們就要用到rsync命令了。它可以實現增量拷貝,也支持遠程同步。本地拷貝:rsync -av /etc/passwd /tmp/1.txt遠程拷貝:rsync -av
【從零開始搭建自己的.NET Core Api框架】(三)集成輕量級ORM——SqlSugar:3.3 自動生成實體類
i++ 點運算 自己的 yui content project style ref 數據庫表 系列目錄 一. 創建項目並集成swagger 1.1 創建 1.2 完善 二. 搭建項目整體架構 三. 集成輕量級ORM框架——SqlSugar 3.1 搭建環境
生成、打包、部署和管理應用程式及型別(上)
1 生成、打包、部署和管理應用程式及型別 1.1 .net framework 部署目標 Windows一直不穩定和過於複雜(其實也很封閉,逐漸開放,如core),微軟認為主要原因是: (1)應用程式來自微軟或其他廠商的dll,多個廠商的程式碼
生成、打包、部署和管理應用程式及型別(下)
1.1 將模組合併成程式集 Clr操作的是程式集。它會載入包含清單元素據表的檔案,根據清單來獲取程式集中的其他檔名稱。程式集特點: (1)定義了可重用的型別 (2)用一個版本標記 (3)可以關聯安全資訊 使用程式集的好處: (1)不同的型別用不同的檔案,使檔案能以增量方式下
idea中添加web.xml配置文件與tomcat啟動中遇到的web.xml文件找不到的問題
解決 目的 信息 需要 遇到 技術分享 maven打包 ima clas 1,如何在idea中向war項目中添加web.xml的配置文件 idea通過maven創建war項目時沒有指定是webapp導致創建出來的項目沒有webapp的文件夾。其實war項目中都是在"項目名/
用VSCode開發一個asp.net core2.0+angular5項目(5): Angular5+asp.net core 2.0 web api文件上傳
owb bus sed loaded runt ace created one 做了 第一部分: http://www.cnblogs.com/cgzl/p/8478993.html 第二部分: http://www.cnblogs.com/cgzl/p/8481825.
FastDFS的配置、部署與API使用解讀(8)FastDFS多種檔案上傳介面詳解
《Poechant的FastDFS的配置、部署與API使用教程》 FastDFS的配置、部署與API使用解讀——(1)入門使用教程 FastDFS的配置、部署與API使用解讀——(2)Java API:根據InputStream、檔名、檔案長度上傳檔案 FastDFS的配置、部署與API
web api 文件 html css js
Web API Web API介紹 API的概念 API(Application Programming Interface,應用程式程式設計介面)是一些預先定義的函式,目的是提供應用程式與開發人員基於某軟體或硬體得以訪問一組例程的能力,而又無需訪
【116】vue-router使用懶載入機制,在生產環境中,如何避免瀏覽器快取Webpack 3 編譯後生成的js路徑,導致404錯誤。(二)
整理思路 要解決這個問題,F5 重新整理是最好的解決辦法。但是每次釋出新版本後,都要求使用者主動按 F5 重新整理瀏覽器,會讓使用者覺得不方便。這對於快速迭代的產品來說尤其突出。 所以為了方便使用者使用,我們希望當前端頁面修改之後,系統能夠自動重新整理頁
【115】vue-router使用懶載入機制,在生產環境中,如何避免瀏覽器快取Webpack 3 編譯後生成的js路徑,導致404錯誤。(一)
前言 為了適應不斷變化的市場需求,軟體產品需要持續部署。生產環境的部署週期往往短則一週,長則半個月。在這一持續部署的過程中,前端開發人員要面臨一個問題:生產環境部署了新版本的程式碼後,如果使用者沒有 F5 重新整理瀏覽器,就會導致瀏覽器快取Webpack 3
CNTK API文件翻譯(17)——多對多神經網路處理文字資料(1)
(本期教程需要翻譯的內容實在是太多了,將其分割成兩期,本期主要講理論和模型建立,下期主要講訓練、測試、優化等) 背景和簡介 本教程將帶你過一遍多對多神經網路基礎,以及如何在CNTK中實現它。具體來說,我們將實現一個多對多模型用來實現字音轉換。我們首先會介
CNTK API文件翻譯(18)——多對多神經網路處理文字資料(2)
(本期教程需要翻譯的內容實在是太多了,將其分割成兩期,上期主要講理論和模型建立,本期主要講訓練、測試、優化等) 訓練 在我們開始訓練之前,我們將定義訓練封裝器、貪婪解碼封裝器以及用於訓練模型的準則函式。首先是訓練封裝器。 def create_mo
【無私分享:ASP.NET CORE 專案實戰(第二章)】新增EF上下文物件,新增介面、實現類以及無處不在的依賴注入(DI)
目錄索引 簡介 上一章,我們介紹了安裝和新建控制器、檢視,這一章我們來建立個數據模型,並且新增介面和實現類。 新增EF上下文物件 按照我們以前的習慣,我們還是新建幾個資料夾 Commons:存放幫助類 Domians:資料模型 Services
.NET Core API框架實戰(三) 使用Swagger文件實現上傳檔案
介紹 在Swagger中利用 IOperationFilter 操作來實現檔案上傳 檔案上傳 1、介紹 寫過介面的朋友都知道,除錯、維護介面是一件非常重要的一件事;swagger是一款非常不錯的介面文件工具,那麼在本期中,我們就用swagge