自用的Swagger3的Config的配置文件,放在config文件夹下

Swagger3的Config的配置文件,放在config文件夹下

@Configuration
public class Swagger3Config {
    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket restApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }
    //创建该API的基本信息(这些基本信息会展现在文档页面中)
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("title")
                .description("https://baidu.com")
                .termsOfServiceUrl("https://baidu.com")
                .contact(new Contact("dada", "https://baidu.com", "2391356197@qq.com"))
                .build();
    }
}
  • 2
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger是一个API文档工具,它提供了API管理、测试和访问等功能。在Python中,有几个相关的包可以使用Swagger,如connexion、flasgger、flask-swagger和Flask-RESTPlus等。其中,flasgger是一个与Python web服务框架Flask高度集成的工具,它自带前端页面,无需安装其他依赖。 配置Swagger的方式有两种,一种是使用配置文件,另一种是在代码中进行全局配置。在配置文件方式中,你需要将注释放入api_get.yml文件中,并使用装饰器@swag_from来引用该文件。可以通过以下代码来实现: ```python from flask import Flask import random from flasgger import Swagger, swag_from app = Flask(__name__) Swagger(app) @app.route('/api/<string:language>/', methods=['GET']) @swag_from("api_get.yml") def index(language): # your code here app.run(debug=True) ``` 而在全局配置方式中,你可以使用Swaggerconfig参数和template参数来进行配置,如下所示: ```python from flask import Flask from flasgger import Swagger app = Flask(__name__) swagger_config = { "headers": [], "specs": [ { "endpoint": 'apispec_2', "route": '/apispecification.json', "rule_filter": lambda rule: True, "model_filter": lambda tag: True, } ], "static_url_path": "/flasgger_static", "swagger_ui": True, "specs_route": "/doc/" } template_config = { "info": { "title": "Sample API", "description": "This is a sample API", "version": "1.0.0" } } Swagger(app, template=template_config, config=swagger_config) app.run(debug=True) ``` 以上是Python中使用Swagger配置的简要介绍。你可以根据实际需求进行相应的配置和调整。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值