zoukankan      html  css  js  c++  java
  • ThinkPHP5工程使用swagger写接口文档

    操作步骤如下:

    1. 安装最新版本composer
    curl -sS https://getcomposer.org/installer | php
    mv composer.phar /usr/local/bin/composer
    chmod +x /usr/local/bin/composer
    
    2. composer更换阿里源
    composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/
    
    3. 安装swagger-php,建议全局安装
    composer global require zircote/swagger-php
    ll -n ~/.config/composer/vendor/bin/openapi /usr/local/bin/openapi
    
    4. 在项目public目录中加入swagger-ui的内容,ho_sample_tp5项目public目录中已经包含,如果public目录中已含有项目需要的文件,可以为swagger-ui创建子目录
    
    5. 修改swagger-ui中json文件的加载地址,在项目根目录下
    vim public/index.html 找到类似如下的内容:
    #    window.onload = function() {
    #      // Begin Swagger UI call region
    #      const ui = SwaggerUIBundle({
    #        url: "https://dev0.mydomain.com/ho_sample_tp5/public/api.json",
    #        dom_id: '#swagger-ui',
    #        deepLinking: true,
    修改其中url的内容,设置为本项目接口json文件的实际访问地址
    
    6. 在项目中按要求加入文档注释。
    
    7. 执行命令,生成swagger接口json文档
    openapi -o JSON_FILE_PATH PROJECT_PATH
    其中JSON_FILE_PATH为步骤5中指定的文件地址,PROJECT_PATH为项目地址
    
    8. 浏览器打开http://host/PROJECT_NAME/public,查看swagger文档,例如 https://dev0.mydomain.com/ho_sample_tp5/public
  • 相关阅读:
    发球
    Java学习笔记
    驼峰式命名法
    公式编辑测试
    Python3.5 在Ubuntu16.04上无法画图的解决方案
    Ubuntu16.04 安装flash player
    Spring切面通知执行的顺序(Advice Order)
    修改别人写的利用AOP实现日志监控的问题
    传感器系列之4.10 酒精传感器
    传感器系列之4.8光敏传感器
  • 原文地址:https://www.cnblogs.com/zhaoxizhe/p/12448793.html
Copyright © 2011-2022 走看看