백엔드 개발 PHP 튜토리얼 用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") *   ) * ) */
로그인 후 복사

项目描述信息
Info/api.php
<?php/** * @SWG\Info( *   title="MY Project", *   description=" xxx", * ) * */
로그인 후 복사

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/
로그인 후 복사


sh 执行文件
#!/bin/sh../swagger-php/swagger.phar ../output-docs -o ../documentation/output/
로그인 후 복사

본 웹사이트의 성명
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.

뜨거운 기사 태그

메모장++7.3.1

메모장++7.3.1

사용하기 쉬운 무료 코드 편집기

SublimeText3 중국어 버전

SublimeText3 중국어 버전

중국어 버전, 사용하기 매우 쉽습니다.

스튜디오 13.0.1 보내기

스튜디오 13.0.1 보내기

강력한 PHP 통합 개발 환경

드림위버 CS6

드림위버 CS6

시각적 웹 개발 도구

SublimeText3 Mac 버전

SublimeText3 Mac 버전

신 수준의 코드 편집 소프트웨어(SublimeText3)

PHP 프로젝트에서 API 인터페이스를 호출하여 데이터를 크롤링하고 처리하는 방법은 무엇입니까? PHP 프로젝트에서 API 인터페이스를 호출하여 데이터를 크롤링하고 처리하는 방법은 무엇입니까? Sep 05, 2023 am 08:41 AM

PHP 프로젝트에서 API 인터페이스를 호출하여 데이터를 크롤링하고 처리하는 방법은 무엇입니까?

React API 호출 가이드: 백엔드 API와 상호작용하고 데이터를 전송하는 방법 React API 호출 가이드: 백엔드 API와 상호작용하고 데이터를 전송하는 방법 Sep 26, 2023 am 10:19 AM

React API 호출 가이드: 백엔드 API와 상호작용하고 데이터를 전송하는 방법

Oracle API 사용 가이드: 데이터 인터페이스 기술 탐색 Oracle API 사용 가이드: 데이터 인터페이스 기술 탐색 Mar 07, 2024 am 11:12 AM

Oracle API 사용 가이드: 데이터 인터페이스 기술 탐색

Oracle API 통합 전략 분석: 시스템 간 원활한 통신 달성 Oracle API 통합 전략 분석: 시스템 간 원활한 통신 달성 Mar 07, 2024 pm 10:09 PM

Oracle API 통합 전략 분석: 시스템 간 원활한 통신 달성

Python을 사용하여 API 데이터를 CSV 형식으로 저장 Python을 사용하여 API 데이터를 CSV 형식으로 저장 Aug 31, 2023 pm 09:09 PM

Python을 사용하여 API 데이터를 CSV 형식으로 저장

Laravel API 오류 문제를 처리하는 방법 Laravel API 오류 문제를 처리하는 방법 Mar 06, 2024 pm 05:18 PM

Laravel API 오류 문제를 처리하는 방법

PHP API 인터페이스: 시작하기 가이드 PHP API 인터페이스: 시작하기 가이드 Aug 25, 2023 am 11:45 AM

PHP API 인터페이스: 시작하기 가이드

Laravel을 사용한 RESTful API 개발: 최신 웹 서비스 구축 Laravel을 사용한 RESTful API 개발: 최신 웹 서비스 구축 Aug 13, 2023 pm 01:00 PM

Laravel을 사용한 RESTful API 개발: 최신 웹 서비스 구축

See all articles