symfony中使用NelmioApiDocBundle進行API管理

項目開發對接過程中，在使用postman編寫API之前都是使用API.html表格式的靜態頁作為API的載體，此方法在編寫的時候麻煩不說，後續若是出現API修改文檔維護上也比較麻煩，而且在對接過程中介面無法直接測試訪問查看返回數據是否正確，導致一系列的麻煩出現，使用postman作為載體後雖然在測試以及描述上方便不少但在出現API修改還需要單獨打開postman進行維護。

NelmioApiDocBundle為Symfony提供了一套很方便的API管理，安裝方法：

$ composerrequirenelmio/api-doc-bundle

如果是項目開發中間安裝此Bundle記得清除cache文件夾緩存文件之後再安裝不然conposer.json文件無法更新，之後再進行必經的註冊Bundle

之後寫入以下配置

# app/config/routing.ymlNelmioApiDocBundle:resource:"@NelmioApiDocBundle/Resources/config/routing.yml"prefix:/api/doc# app/config/config.ymlnelmio_api_doc:~

當然，因為此Bundle生成頁面使用的是twig作為模板引擎，所以需要確保啟用twig

# app/config/config.ymlframework:templating:engines:[ twig ]

下面是表達一個API的備註信息，其中

useNelmioApiDocBundleAnnotationApiDoc;

喜歡這篇文章嗎？立刻分享出去讓更多人知道吧！