Restful Api

Restful Api 架构介绍
转载：http://www.ruanyifeng.com/blog/2014/05/restful_api.html

一、框架介绍：Swagger UI, Swagger-PHP, SLim framework
Swagger UI
https://swagger.io/tools/swagger-ui/
Swagger UI允许任何人——无论是您的开发团队还是您的最终消费者——在没有任何实现逻辑的情况下可视化并与API的资源交互。它是由OpenAPI(以前称为Swagger)规范自动生成的，具有可视化文档，便于后端实现和客户端使用。

Swagger-PHP
http://zircote.com/swagger-php/
使用doctrine注释为RESTful API生成交互式OpenAPI文档。
SLim framework
https://www.slimframework.com/
Slim是一个PHP微框架，帮助您快速编写简单但功能强大的web应用程序和api。

二、框架安装
https://pkg.phpcomposer.com/
安装工具composer
https://getcomposer.org/download/
安装工具 composer.phar

 

安装slim
composer require slim/slim "^3.10.0"
php composer.phar require slim/slim "^3.10.0"

安装Swagger-PHP
composer require zircote/swagger-php
php composer.phar require zircote/swagger-php
然而，由于众所周知的原因，国外的网站连接速度很慢，并且随时可能被“墙”甚至“不存在”。

“Packagist 中国全量镜像”所做的就是缓存所有安装包和元数据到国内的机房并通过国内的 CDN 进行加速，这样就不必再去向国外的网站发起请求，
从而达到加速 composer install 以及 composer update 的过程，并且更加快速、稳定。因此，即使 packagist.org、github.com 发生故障（主要是连接速度太慢和被墙），
你仍然可以下载、更新安装包。
如果安装失败，配置下镜像的地址
全局：composer config -g repo.packagist composer https://packagist.phpcomposer.com
全局：php composer.phar config -g repo.packagist composer https://packagist.phpcomposer.com

当前项目：composer config repo.packagist composer https://packagist.phpcomposer.com
当前项目：php composer.phar config repo.packagist composer https://packagist.phpcomposer.com

三、框架整合
3-1、服务器Apache 、Nginx 、IIS 配置
https://www.slimframework.com/docs/v3/start/web-servers.html
3-2、服务端入口文件index.php
<?php
use \Psr\Http\Message\ServerRequestInterface as Request;
use \Psr\Http\Message\ResponseInterface as Response;

require '../vendor/autoload.php';

$app = new \Slim\App;
$app->get('/hello/{name}', function (Request $request, Response $response, array $args) {
    $name = $args['name'];
    $response->getBody()->write("Hello, $name");

    return $response;
});
//配置Swagger-PHP
$app->get('/swagger.json', function ($request, $response) {
    $swagger = \Swagger\scan('./src');
    $response->getBody()->write($swagger);
    return $response;
});
$app->run();
3-3、前端Swagger-UI配置
 window.onload = function() {

      // Build a system
      const ui = SwaggerUIBundle({
        url: "/test/slim/swagger.json", //修改这个位置
        dom_id: '#swagger-ui',
        deepLinking: true,
        presets: [
          SwaggerUIBundle.presets.apis,
          SwaggerUIStandalonePreset
        ],
        plugins: [
          SwaggerUIBundle.plugins.DownloadUrl
        ],
        layout: "StandaloneLayout"
      })

      window.ui = ui
    }

swagger-php注释文档

http://zircote.com/swagger-php/#links

http://zircote.com/swagger-php/1.x/annotations.html#items

https://laravel-china.org/topics/7430/how-to-write-api-documents-based-on-swagger-php

https://bfanger.nl/swagger-explained/#parameterObject