GithubHelp home page GithubHelp logo

wwwk / common-core-swagger-ui Goto Github PK

View Code? Open in Web Editor NEW

This project forked from misterchangray/common-core-swagger-ui

0.0 0.0 0.0 258 KB

基于angular5开发的自定义swagger-ui,显示更友好,更符合我们文档阅读习惯。

License: MIT License

TypeScript 58.96% JavaScript 6.31% HTML 26.79% CSS 7.94%

common-core-swagger-ui's Introduction

common-core-swagger-ui

这个项目是美化swagger本身的文档。偏向企业文档; 增加功能:

  • API检索功能
  • debug优化显示传参

如何扩展

  • clone project
  • run npm start
  • open your browser on http://localhost:4200/
  • 扩展你自己的代码
  • ng build --dev 构建开发使用项目;(js,html不会压缩打包)
  • ng build --prod 构建生产环境项目;(js,html文件会被压缩和打包)

如何在swagger项目中使用

  • 复制项目dist目录到你项目中的web容器中
  • 配置目录下的config.js文件
window.appConfigs  = {
  //swagger后台文档地址
	swaggerApiUrl : "/v2/api-docs",
  //debug请求地址
	debugApiUrl : "http://localhost:8080"
}
  • 启动你的项目,访问其中下index.html文件

注意事项

  • 使用请确保swagger2版本>=2.6
  • 请不要修改后台swagger2接口访问地址,项目是采用的默认地址:baseUrl + /v2/api-docs

部分截图

截图 截图 截图

common-core-swagger-ui's People

Contributors

misterchangray 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.