在springboot專案中使用swaggerui

2022-08-10 03:33:15 字數 3320 閱讀 4916

在pom.xml檔案中配置(用的2.6.1版本,2.9.2有點醜)

<

properties

>

<

spring.swagger2.version

>2.6.1

spring.swagger2.version

>

properties

>

<

dependency

>

<

groupid

>io.springfox

groupid

>

<

artifactid

>springfox-swagger2

artifactid

>

<

version

>$

version

>

dependency

>

<

dependency

>

<

groupid

>io.springfox

groupid

>

<

artifactid

>springfox-swagger-ui

artifactid

>

<

version

>$

version

>

dependency

>

寫配置類

package

com.xt.mybatisplusstudy.config;

import

org.springframework.context.annotation.bean;

import

org.springframework.context.annotation.configuration;

import

springfox.documentation.builders.apiinfobuilder;

import

springfox.documentation.builders.pathselectors;

import

springfox.documentation.builders.requesthandlerselectors;

import

springfox.documentation.service.apiinfo;

import

springfox.documentation.spi.documentationtype;

import

springfox.documentation.spring.web.plugins.docket;

import

springfox.documentation.swagger2.annotations.enableswagger2;

@configuration

@enableswagger2

public

class

swagger2config

private

apiinfo apiinfo()

}

注釋介紹

常用註解:

- @api()用於類;

表示標識這個類是swagger的資源

- @apioperation()用於方法;

表示乙個http請求的操作

- @apiparam()用於方法,引數,字段說明;

表示對引數的新增元資料(說明或是否必填等)

- @apimodel()用於類

表示對類進行說明,用於引數用實體類接收

- @apimodelproperty()用於方法,字段

表示對model屬性的說明或者資料操作更改

- @apiignore()用於類,方法,方法引數

表示這個方法或者類被忽略

- @apiimplicitparam() 用於方法

表示單獨的請求引數

- @apiimplicitparams() 用於方法,包含多個 @apiimplicitparam

具體使用舉例說明:

@api()

用於類;表示標識這個類是swagger的資源

tags–表示說明

value–也是說明,可以使用tags替代

但是tags如果有多個值,會生成多個list

@apioperation() 用於方法;表示乙個http請求的操作

value用於方法描述

notes用於提示內容

tags可以重新分組(視情況而用)

@apiparam() 用於方法,引數,字段說明;表示對引數的新增元資料(說明或是否必填等)

name–引數名

value–引數說明

required–是否必填

@apimodel()用於類 ;表示對類進行說明,用於引數用實體類接收

value–表示物件名

description–描述

都可省略

@apimodelproperty()用於方法,字段; 表示對model屬性的說明或者資料操作更改

value–字段說明

name–重寫屬性名字

datatype–重寫屬性型別

required–是否必填

example–舉例說明

hidden–隱藏

@apiignore()用於類或者方法上,可以不被swagger顯示在頁面上

比較簡單, 這裡不做舉例

@apiimplicitparam() 用於方法

表示單獨的請求引數

@apiimplicitparams() 用於方法,包含多個 @apiimplicitparam

name–引數ming

value–引數說明

datatype–資料型別

paramtype–引數型別

example–舉例說明

訪問

localhost:8081/xt/swagger-ui.html 訪問原則-->ip+專案名+swagger-ui.html

效果示例

遇到的乙個坑

//

@api(value = "登入介面",tags = "login control") 坑 tags中如果寫中文,swaggerui介面無法展開

@api(description = "登入介面")

springboot專案中使用druid資料來源

引入druid資料來源 com.alibaba groupid druid artifactid 1.1.9 version dependency 或者引入druid資料來源 spring datasource 資料來源基本配置 username root password root driver ...

在專案中使用ExtJS

今天extjs官網發布了extjs最新正式版4.2.1。extjs為開發者在開發富客戶的b s應用中提供豐富的ui元件,具有統一的主題,便於快速開發,提高效率。但顯然它並不適合互聯 的開發。builds 壓縮後的extjs 體積更小,更快 docs 開發文件 examples 官方演示示例 loca...

在專案中使用springmvc

springmvc是spring框架的乙個模組,springmvc和spring無需通過中間整個層進行整合,它是乙個基於mvc的web框架。springmvc是基於方法開發的,struts2是基於類開發的。springmvc將url和controller方法對映,對映成功後springmvc生成乙個...