国产xxxx99真实实拍_久久不雅视频_高清韩国a级特黄毛片_嗯老师别我我受不了了小说

資訊專(zhuān)欄INFORMATION COLUMN

Swagger 生成 PHP API 接口文檔

miya / 2723人閱讀

摘要：有同學(xué)推薦了，是一個(gè)簡(jiǎn)單但功能強(qiáng)大的表達(dá)工具。這里介紹使用生成文檔的方法。將文檔輸出值的根目錄下，可通過(guò)訪(fǎng)問(wèn)此文檔。執(zhí)行結(jié)果如圖參考資料生成接口文檔如何編寫(xiě)基于的文檔使用生成文檔不完全指南

Swagger 生成 PHP API 接口文檔

標(biāo)簽（空格分隔）： php

1、概況

有同學(xué)反饋寫(xiě)幾十個(gè)接口文檔需要兩天的工作量, 隨著多部門(mén)之間的協(xié)作越來(lái)越頻繁, 維護(hù)成本越來(lái)越高, 文檔的可維護(hù)性越來(lái)越差, 需要一個(gè)工具來(lái)管理這些接口的文檔, 并能夠充當(dāng)mock server給調(diào)用方使用。

有同學(xué)推薦了swagger+easymock，Swagger是一個(gè)簡(jiǎn)單但功能強(qiáng)大的API表達(dá)工具。 這里介紹使用swagger-php生成PHP API文檔的方法。

2、安裝與使用 2.1 安裝swagger-php包 
git clone https://github.com/zircote/swagger-php.git

composer install
// 全局的
composer global require zircote/swagger-php

// 項(xiàng)目中
composer global require zircote/swagger-php
2.2 laravel項(xiàng)目安裝

使用 L5 Swagger https://github.com/DarkaOnLine/L5-Swagger

具體安裝過(guò)程請(qǐng)參考此文檔: https://github.com/DarkaOnLin...

2.3 編寫(xiě)API注解 
# 創(chuàng)建文件 demo/customer.php

2.4 生成swagger API 文件

./swagger-php/bin/openapi demo -o ./docs


API 內(nèi)容如下:


# docs/openapi.yaml
openapi: 3.0.0
info:
  title: "My First API"
  version: "0.1"
paths:
  /customer/info:
    get:
      summary: 用戶(hù)的個(gè)人信息
      description: "這不是個(gè)api接口,這個(gè)返回一個(gè)頁(yè)面"
      operationId: "Customer::info"
      parameters:
        -
          name: userId
          in: query
          description: 用戶(hù)ID
          required: true
          schema:
            type: string
      responses:
        "200":
          description: "An example resource"

3、展示

git clone https://github.com/swagger-api/swagger-ui.git

composer install


直接通過(guò)Dockerfile構(gòu)建、啟動(dòng)項(xiàng)目， 或者使用docker-compose進(jìn)行服務(wù)管理。


version: "2"

services:
    swagger-ui:
      build: .
      ports:
        - "8080:8080"
      volumes:
        - ./dist/:/usr/share/nginx/html/
      restart: on-failure


訪(fǎng)問(wèn) http://localhost:8080/ 即可到 swagger 編輯器預(yù)覽界面。


./swagger-php/bin/openapi demo -o ./swagger-ui/dist/


將 api文檔輸出值swagger ui的根目錄下，可通過(guò) http://localhost:8080/openapi.yaml 訪(fǎng)問(wèn)此api文檔。


執(zhí)行 Explore 結(jié)果如圖:



4、參考資料


Swagger 生成 PHP restful API 接口文檔


如何編寫(xiě)基于 Swagger-PHP 的 API 文檔


https://github.com/zircote/swagger-php


https://github.com/swagger-api/swagger-ui


Easy Mock


Laravel（PHP）使用Swagger生成API文檔不完全指南

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://m.specialneedsforspecialkids.com/yun/29560.html

相關(guān)文章

  • Swagger 生成 PHP restful API 接口文檔

    摘要：需求和背景需求為客戶(hù)端同事寫(xiě)接口文檔的各位后端同學(xué)已經(jīng)在各種場(chǎng)合回憶了使用自動(dòng)化文檔工具前手寫(xiě)文檔的血淚史我的故事卻又不同因?yàn)槭紫葋?lái)說(shuō)我在公司是組負(fù)責(zé)人屬于上述血淚史中催死人不償命的客戶(hù)端陣營(yíng)但血淚史卻是相通的沒(méi)有自動(dòng)化文檔的日子對(duì)接口就是 需求和背景 需求: 為客戶(hù)端同事寫(xiě)接口文檔的各位后端同學(xué),已經(jīng)在各種場(chǎng)合回憶了使用自動(dòng)化文檔工具前手寫(xiě)文檔的血淚史.我的故事卻又不同,因?yàn)槭紫葋?lái)說(shuō)...

    xiaotianyi 評(píng)論0 收藏0

  • Swagger PHP使用指南

    摘要：，已經(jīng)好了，試著訪(fǎng)問(wèn)根目錄下，比如試試，出現(xiàn)界面就成功了沒(méi)從先就用命令看下的路由最上面條就是剛剛添加的路由。 先說(shuō)什么是Swagger, Swagger的使用目的是方便優(yōu)美的呈現(xiàn)出接口API的各種定義, 生成API文檔, 包括參數(shù), 路徑之類(lèi). 有時(shí)后端改了API的參數(shù)或者其他設(shè)置, 前端直接看這個(gè)Swagger UI就可以, 方便項(xiàng)目管理和團(tuán)隊(duì)協(xié)作. 官網(wǎng): http://swagg...

    cnio 評(píng)論0 收藏0

  • Lumen微服務(wù)生成Swagger文檔

    摘要：本文將會(huì)告訴你如何借助中插件，在開(kāi)發(fā)微服務(wù)項(xiàng)目時(shí)項(xiàng)目和其它項(xiàng)目方法類(lèi)似快速的在代碼中使用注釋來(lái)創(chuàng)建文檔。本文將會(huì)持續(xù)修正和更新，最新內(nèi)容請(qǐng)參考我的上的程序猿成長(zhǎng)計(jì)劃項(xiàng)目，歡迎，更多精彩內(nèi)容請(qǐng)?？蚣芘渲梦覀兪褂卯?dāng)前最新的來(lái)演示。 showImg(https://segmentfault.com/img/remote/1460000017715535?w=1072&h=711); 作為一名...

    alighters 評(píng)論0 收藏0

  • Java | Spring Boot Swagger2 集成REST ful API 生成接口文檔

    摘要：集成生成接口文檔原文簡(jiǎn)介由于的特性，用來(lái)開(kāi)發(fā)變得非常容易，并且結(jié)合來(lái)自動(dòng)生成文檔變得方便快捷。使用生成，我們可以得到交互式文檔。聽(tīng)過(guò)與的結(jié)合，生成更加完備的文檔。接下來(lái)將基于與搭建完整的文檔系統(tǒng)。 Spring Boot Swagger2 集成REST ful API 生成接口文檔 原文 簡(jiǎn)介 由于Spring Boot 的特性，用來(lái)開(kāi)發(fā) REST ful 變得非常容易，并且結(jié)合 Sw...

    joyvw 評(píng)論0 收藏0

  • Spring Boot中使用Swagger2構(gòu)建API文檔

    摘要：使用生成，我們可以得到交互式文檔，自動(dòng)生成代碼的以及的發(fā)現(xiàn)特性等。方法指定掃描的包會(huì)生成文檔默認(rèn)是顯示所有接口可以用注解標(biāo)識(shí)該接口不顯示。 程序員都很希望別人能寫(xiě)技術(shù)文檔，自己卻很不愿意寫(xiě)文檔。因?yàn)榻涌跀?shù)量繁多,并且充滿(mǎn)業(yè)務(wù)細(xì)節(jié),寫(xiě)文檔需要花大量的時(shí)間去處理格式排版,代碼修改后還需要同步修改文檔,經(jīng)常因?yàn)轫?xiàng)目時(shí)間緊等原因?qū)е挛臋n滯后于代碼，接口調(diào)用方的抱怨聲不絕于耳。而程序員是最擅長(zhǎng)偷...

    taohonghui 評(píng)論0 收藏0

發(fā)表評(píng)論

0條評(píng)論

miya

男|高級(jí)講師

TA的文章

閱讀更多
最新活動(dòng)
閱讀需要支付1元查看
<