Heim Backend-Entwicklung PHP-Tutorial 用swagger-php/ui作API测试

用swagger-php/ui作API测试

Jun 13, 2016 pm 12:14 PM
api swagger

用swagger-php/ui做API测试
功能:
1 swagger-php根据自定义的规则生成API请求规则,通过phar生成json文件
2 打开swagger-ui/dist/index.html。输入json文件夹目录地址(需要同源),swagger-ui会根据请求的JSON生成API,页面很漂亮。输入请求参数后执行会获取返回值。
缺点:不能对返回的数据进行验证。功能类似chrome的插件postman。
Api Action测试参考代码:
Resource/PostAction.php

<?php/** * @SWG\Resource( *   apiVersion="2.2.0", *   swaggerVersion="1.2", *   basePath="http://test.xxx.com/Api/Post", *   resourcePath="/Post", *   description="Operations about Post", *   produces="['application/json']" * ) *//** * @SWG\Api( *   path="/apps", *   @SWG\Operation( *     method="POST", *     summary="Find app by buID", *     notes="Returns apps based on BUID", *     type="Post", *     nickname="apps", *     authorizations={}, *     @SWG\Parameter( *       name="apiVersion", *       description="api version", *       required=true, *       type="integer", *       format="int64", *       paramType="form", *       minimum="1.0", *       allowMultiple=false *     ), *     @SWG\Parameter( *       name="sessionID", *       description="user login session", *       required=true, *       type="string", *       paramType="form", * 		 defaultValue="9f6cdd0858a1e93b1426659b283a93ec", *       allowMultiple=false *     ), *	  @SWG\Parameter( *       name="buID", *       description="BU ID", *       required=true, *       type="int64", *       paramType="form", *       allowMultiple=false *     ), *     @SWG\ResponseMessage(code=400, message="Invalid ID supplied"), *     @SWG\ResponseMessage(code=404, message="Post not found"), * 	   @SWG\ResponseMessage(code=405, message="Invalid input"), * 	   @SWG\ResponseMessage(code=200, message="success") *   ) * ) */
Nach dem Login kopieren

项目描述信息
Info/api.php
<?php/** * @SWG\Info( *   title="MY Project", *   description=" xxx", * ) * */
Nach dem Login kopieren

readme
# Usage of API Docs### Raw Spec Structure* Info - General Info.* Model - Entity Class* Resource - API endpoint### Compile API info.* after modify the spec, run shell script, as follows.	`cd api-docs`		`./genDocumentation.sh`* the compiled content (.json) is stored in documentation/Output/### View API docs* visit http://{domain}/documenation/
Nach dem Login kopieren


sh 执行文件
#!/bin/sh../swagger-php/swagger.phar ../output-docs -o ../documentation/output/
Nach dem Login kopieren

Erklärung dieser Website
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn

Heiße Artikel -Tags

Notepad++7.3.1

Notepad++7.3.1

Einfach zu bedienender und kostenloser Code-Editor

SublimeText3 chinesische Version

SublimeText3 chinesische Version

Chinesische Version, sehr einfach zu bedienen

Senden Sie Studio 13.0.1

Senden Sie Studio 13.0.1

Leistungsstarke integrierte PHP-Entwicklungsumgebung

Dreamweaver CS6

Dreamweaver CS6

Visuelle Webentwicklungstools

SublimeText3 Mac-Version

SublimeText3 Mac-Version

Codebearbeitungssoftware auf Gottesniveau (SublimeText3)

Wie kann ich Daten durch Aufrufen der API-Schnittstelle in einem PHP-Projekt crawlen und verarbeiten? Wie kann ich Daten durch Aufrufen der API-Schnittstelle in einem PHP-Projekt crawlen und verarbeiten? Sep 05, 2023 am 08:41 AM

Wie kann ich Daten durch Aufrufen der API-Schnittstelle in einem PHP-Projekt crawlen und verarbeiten?

React API Call Guide: So interagieren und übertragen Sie Daten mit der Backend-API React API Call Guide: So interagieren und übertragen Sie Daten mit der Backend-API Sep 26, 2023 am 10:19 AM

React API Call Guide: So interagieren und übertragen Sie Daten mit der Backend-API

Oracle API-Nutzungshandbuch: Erkundung der Datenschnittstellentechnologie Oracle API-Nutzungshandbuch: Erkundung der Datenschnittstellentechnologie Mar 07, 2024 am 11:12 AM

Oracle API-Nutzungshandbuch: Erkundung der Datenschnittstellentechnologie

Analyse der Oracle API-Integrationsstrategie: Erreichen einer nahtlosen Kommunikation zwischen Systemen Analyse der Oracle API-Integrationsstrategie: Erreichen einer nahtlosen Kommunikation zwischen Systemen Mar 07, 2024 pm 10:09 PM

Analyse der Oracle API-Integrationsstrategie: Erreichen einer nahtlosen Kommunikation zwischen Systemen

Speichern Sie API-Daten mit Python im CSV-Format Speichern Sie API-Daten mit Python im CSV-Format Aug 31, 2023 pm 09:09 PM

Speichern Sie API-Daten mit Python im CSV-Format

So gehen Sie mit Laravel-API-Fehlerproblemen um So gehen Sie mit Laravel-API-Fehlerproblemen um Mar 06, 2024 pm 05:18 PM

So gehen Sie mit Laravel-API-Fehlerproblemen um

PHP-API-Schnittstelle: Erste Schritte PHP-API-Schnittstelle: Erste Schritte Aug 25, 2023 am 11:45 AM

PHP-API-Schnittstelle: Erste Schritte

RESTful API-Entwicklung mit Laravel: Aufbau moderner Webdienste RESTful API-Entwicklung mit Laravel: Aufbau moderner Webdienste Aug 13, 2023 pm 01:00 PM

RESTful API-Entwicklung mit Laravel: Aufbau moderner Webdienste

See all articles