草庐IT

$swagger

全部标签

java - 使用Javadocs生成Swagger文档

我想为一组现有的RESTfulAPI构建Swagger文档。我有以下要求:离线生成Swagger文档(我使用了http://kongchen.github.io/swagger-maven-plugin/)。这个插件帮助我在编译期间生成Swagger文档。阅读现有的Javadoc,以便在Swagger文档中使用它们。到目前为止,使用上述插件我能够实现第1点。因此对于现有的REST方法:/****Getsthe{@linkDisplayPreferenceModel}withthenameasprovidedintheparameter.Thepreferencewiththegiven

java - 在 Swagger-UI 中对 API 方法进行排序

我找不到任何工作示例,如何实现以下目标:我希望Swagger-UI中的API方法按方法(GET-POST-PUT-DELETE)或/AND按字母顺序排序。到目前为止,所有方法都以随机顺序显示,甚至不是按照我的源代码给出的顺序显示。我使用Jax-RS+Jersey1。使用@ApiOperation的位置属性排序对我来说不是一个选项,因为方法太多而且API仍在扩展,所以如果有新方法我需要更新所有。有什么提示吗? 最佳答案 SwaggerUI2.1.0+的更新:sorter参数已拆分为两个参数,如Fix1040中所述,Fix1280:ap

python - 如何使用代码中的注释从 python 生成 swagger 规范文件 (json)?

问题陈述:我想自动生成JSONAPI的机器和人类可读规范,以便任何人都可以可视化我们的API并与之交互。其中一个可行的解决方案是使用OpenAPISpecification。(fka招摇)。我找不到一个易于理解的指南来使用swagger,尤其是在Tornado中,所以我的问题是:如何根据python代码中的注释自动生成swagger规范文件?我也在使用JSONschemas对于输入验证,我如何将它们与swagger规范集成。我的API是用python2.7.11和tornado4.3编写的。如果您除了使用swagger还有其他建议,请提出建议。更新:Apispec是一个有趣的开始,但它

python - 将 Swagger/OpenAPI 生成的 python 服务器与现有的 Flask 应用程序集成

我有兴趣将swagger-codegen生成的Python服务器与现有的Flask应用程序集成。swagger-codegen基于Connexion生成一个Python实现来自SwaggerAPIspecification的图书馆.examples我发现所有人似乎都期待connexion.App管理整个flask应用程序。importconnexionapp=connexion.App(__name__,specification_dir='swagger/')app.add_api('my_api.yaml')app.run(port=8080)但是,我有现有的蓝图、配置和sqlal

python - 为什么这个 django-rest-swagger API 文档不能正常显示/工作?

我已经构建了一个DjangoAPI,当通过POST给定一个电子邮件地址时,它会用一个bool值来响应,该值指示是否天气该电子邮件地址已经存在于我的数据库中:classisEmailTaken(views.APIView):permission_classes=[permissions.AllowAny,]defpost(self,request,*args,**kwargs):try:email=request.DATA['email']exceptKeyError:returnHttpResponse('Anemailwasnotgivenwiththisrequest.',stat

python - 将生成的 Flask 应用程序代码 (Swagger-Codegen) 粘合到后端实现的最干净的方法

我有:做[Stuff]的图书馆一个swaggerAPI定义,大致排名第一,但有细微差别以干净地映射到REST服务使用Swagger-Codegen生成的flask应用程序生成#2-例如导致pythonController功能与#1大致一对一。我的意图是flask应用程序(所有生成的代码)应该只处理实际RESTapi和参数解析的映射,以匹配以swagger编码的API规范。在任何参数解析(同样是生成的代码)之后,它应该直接调用我的(非生成的)后端。我的问题是,如何在不手动编辑生成的python/flask代码的情况下最好地将它们连接起来?(关于我的设计的反馈,或实现此目的的正式设计模式的

python - 从 Django REST Swagger 中排除 URL

我想从我的RESTAPI文档中排除一些URL。我正在使用DjangoRESTSwagger,我能找到的唯一文档(https://github.com/marcgibbons/django-rest-swagger)并没有告诉我太多信息。settings.py中有SWAGGER_SETTINGS的“exclude_namespaces”部分,但没有关于如何使用它的真正解释或示例。简单地说,我想从文档中排除以以下内容开头的任何URL:/api/jobs/status//api/jobs/parameters/我该怎么做呢?在此先感谢您提供的任何帮助:P 最佳答案

javascript - Jersey 2 : render Swagger static content correctly without trailing slash(/)

我做的是用Grizzly/Jersey来托管swagger-ui,就是静态内容。这是build.gradle的一部分:compile'org.glassfish.jersey.core:jersey-server:2.22.1'compile'org.glassfish.jersey.containers:jersey-container-grizzly2-http:2.22.1'compile'org.glassfish.jersey.containers:jersey-container-grizzly2-servlet:2.22.1'以下是使用Grizzly配置静态内容的方法:h

html - 在 springfox-swagger-ui 中渲染 html

我最近更新了一个运行springfox-swagger2和springfox-swagger-ui2.5.0的应用程序以使用版本2.6.0。应用程序的API文档使用,和标签,在2.5.0中正确呈现,但在2.6.0版中呈现和标记被swagger-ui忽略。我需要做什么才能让springfox再次渲染HTML标签?标签用在以下位置:ApiInfoBuilder().description("HERE")@ApiOperation(notes="HERE")@ApiResponse(message="HERE") 最佳答案 在尝试使用@A

java - Spring Boot 和 Swagger 文本/html 响应映射

我有一个非常简单的javaspringboot+swagger项目。仅出于测试目的,我创建了两个映射类:Names.java和NamesContainer.javapublicclassNames{@XmlAttribute(name="ref")@ApiModelProperty(notes="Theauto-generatedversionoftheproduct...")privateStringkey;@XmlValue@ApiModelProperty(notes="Theauto-generatedversionoftheproduct...")privateStringn