ホームページ > バックエンド開発 > PHPチュートリアル > API テストには swagger-php/ui を使用する

API テストには swagger-php/ui を使用する

WBOY
リリース: 2016-06-13 12:15:12
オリジナル
1861 人が閲覧しました

API テストに swagger-php/ui を使用する
機能:
1 swagger-php はカスタム ルールに基づいて API リクエスト ルールを生成し、phar を通じて json ファイルを生成します
2 swagger-ui/dist/index.html を開きます。 json フォルダーのディレクトリ アドレスを入力すると (同じオリジンが必要です)、swagger-ui は要求された JSON に基づいて API を生成し、ページは非常に美しくなります。リクエストパラメータを入力すると、実行により戻り値が返されます。
欠点: 返されたデータは検証できません。この機能は、Chrome プラグインの postman に似ています。
Api Action テスト リファレンス コード:
Resource/PostAction.php
Java コード コレクション コード
/**
* @SWGResource(
* apiVersion="2.2.0",
* swaggerVersion="1.2",
* basePath="http://test.xxx.com/Api/Post" ,
* resourcePath="/Post",
* description="投稿に関する操作",
* generated="['application/json']"
* )
*/

/* *
* @SWGApi(
* path="/apps",
* @SWGOperation(
* Method="POST",
* summary="buID でアプリを検索",
* Notes="BUID に基づいてアプリを返します",
* type="投稿",
* Nickname="アプリ",
* authorizations={},
* @SWGParameter(
* name="apiVersion",
* description="api version",
* required=true,
* type="integer",
* format="int64",
* paramType="form",
* minimum="1.0",
* allowMultiple=false
* ),
* @SWGParameter(
* name="sessionID",
* description="ユーザーログインセッション",
* required=true,
* type="string",
* paramType="form",
* defaultValue="9f6cdd0858a1e93b1426659b283a93ec", > * allowMultiple=false
* ),
* @SWGParameter(
* name="buID",
* description="BU ID",
* required=true,
* type="int64",
* paramType="form",
* allowMultiple=false
* ),
* @SWGResponseMessage(code=400, message="無効な ID が指定されました"),
* @SWGResponseMessage(code=404, message="投稿が見つかりません"),
* @SWGResponseMessage(code=405, message="無効な入力"),
* @SWGResponseMessage(code=200, message ="成功")
* )
* )
*/

プロジェクトの説明情報
Info/api.php
Java コード コレクション コード

/**
* @SWGInfo(
* title="MY プロジェクト",
* description=" xxx",
* )
*
* /

readme
Java コード コレクション コード
# API ドキュメントの使用法
### 生の仕様構造
* 情報 - 一般情報
* モデル - エンティティ クラス
* リソース - API エンドポイント

### API 情報をコンパイルします。
* 仕様を変更した後、次のようにシェル スクリプトを実行します。 >
`./genDocumentation.sh`

* コンパイルされたコンテンツ (.json) は document/Output/ に保存されます

### API ドキュメントを表示
* http にアクセスしてください://{domain}/documination/


sh 実行ファイル
Java コード コレクション コード
#!/bin/sh
../swagger-php/swagger.phar ../output-docs -o ../documentation/output/


関連ラベル:
ソース:php.cn
このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
人気のチュートリアル
詳細>
最新のダウンロード
詳細>
ウェブエフェクト
公式サイト
サイト素材
フロントエンドテンプレート