Giter Site home page Giter Site logo

swagger's People

Contributors

sweetit avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

swagger's Issues

希望添加返回参数标注

@sweetit 最近使用公司古老的框架集成了swagger4j,发现特别好用,唯独缺少一块很重要的部分,就是暂时无法直观的展示接口返回值中各参数具体代表什么含义,希望能够添加返回参数的标注。

struts是否必须配置为api

文档说要配置<package name="api" namespace="/api" extends="struts-default" >
但我的项目中已经有/api这个路径了,所以现在配置成了<package name="apis" namespace="/apis" extends="struts-default" >

然后通过http://localhost:8080/项目名/apis/index能访问到一个不完整的页面,后台看报错信息,提示:Could not find action or result: /项目名/api/statics?url=lib/jquery-1.8.0.min.js

从提示看,似乎swagger4j中,写死了api这个路径?怎么才能配置成apis?

关于swagger的第一次修改完成

老哥,我这已经修改完成了。我有个想法,想给param加一个只读参数,我看现在已经有默认值了。您说我的想法怎么样

希望可以在@APIs中增加description成员,并可以在页面展示

cpjit/swagger使用起来挺方便的,我们项目一直在使用,给我们团队的接口展示和沟通带来不少帮助。
现在希望可以在@apis的成员中增加description,用以表示这个REST服务类的用途,而不是它的路径,路径罗列出来有时候不是非常直观。希望达到如下图效果就更好了。

image

关于返回参数

之后会添加返回参数的注解还有实体bean内部的注解吗

dataType指定Array类型报错

@API(value = "test", summary = "获取用户信息", method = "POST", description = "用户对象", parameters = {
@param(in = "body", name = "user", description = "用户对象", dataType = DataType.ARRAY)

})

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.