Giter VIP home page Giter VIP logo

php-swagger-ui's Introduction

php-swagger-ui

Introduction

一个基于 php-swagger 生成PHP API在线文档的UI项目

Installation

composer create-project --prefer-dist bobitluo/php-swagger yourproject

Usage

修改 config.yaml

projects:
  your_first_project:  # 定义项目KEY。可配置多个项目
    type: directory
    dir: /your/project/controller/dir   # 配置成项目controller的目录(建议部署在开发或测试环境)
    swagger:
      title: project name
      description: project description
      version: project version
      host: your_project_host.com   # 配置成项目的主机名(建议配置开发或测试环境的主机)
      schemes: 
        - https
      securityDefinitions:  # 认证相关配置。请参考 https://swagger.io/docs/specification/2-0/authentication/
        ApiKeyAuth:
          type: apiKey
          in: header
          name: Authorization
      security:
        - ApiKeyAuth: []
      controller_prefix: 
      controller_postfix: Controller
      action_prefix: 
      action_postfix: Action

PHP注释格式

PHP注释格式

php-swagger-ui's People

Contributors

bobitluo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.