03 Swagger2構建Restful文件

2021-09-03 08:15:52 字數 1911 閱讀 2266

io.springfox

springfox-swagger2

2.2.2

io.springfox

springfox-swagger-ui

2.2.2

package com.study.model;

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 swaggerconfig

}注意:  上面的包名是對應工程的包  我的包是這樣的

上述**中,通過@configuration註解,讓spring來載入該類配置,通過@enableswagger2註解來啟用swagger2。

再通過createrestapi函式建立docket的bean之後,apiinfo是用來建立介面文件的基本資訊(這些基本資訊會展現在文件頁面中)。select()函式返回乙個apiselectorbuilder例項用來控制哪些介面暴露給swagger來展現,本例採用指定掃瞄的包路徑來定義,swagger會掃瞄該包下所有controller定義的api,並產生文件內容(除了被@apiignore指定的請求)。

package com.study.model.controler;

import io.swagger.annotations.apiimplicitparam;

import io.swagger.annotations.apiimplicitparams;

import io.swagger.annotations.apioperation;

import org.springframework.web.bind.annotation.*;

@restcontroller

public class usercontroller

@apioperation(value="獲取使用者資訊", notes="根據獲取對應使用者資訊")

public string get(@pathvariable("username") string username)

@apioperation(value="登入", notes="根據url中的username、pwd進行使用者登入驗證")

@apiimplicitparams()

public string login(@requestparam string username, @requestparam string pwd)

}

構建之法03

瀑布模型是將軟體生存週期的各項活動規定為按固定順序而連線的若干階段工作,形如瀑布流水,最終得到軟體產品。它在1970年由溫斯頓 羅伊斯 winston royce 提出,直到80年代早期,它一直是唯一被廣泛採用的軟體開發模型。本書中例出了瀑布模型的文件圖,但是鄙人並沒有看得很懂它的用意。搜尋一些關於...

構建之法03

在現實社會中,人們為了解決生活中的各種問題,需要借助於軟體。但,每個人的需求都有不同,軟體團隊通過以下幾個步驟來獲取人們的需求 1.獲取和引導需求 軟體團隊需要找到軟體得利益相關者,了解挖掘他們對軟體的需求,引導他們表達出真實需求。同時,需求還可以來自各種管理機構,還可以來自軟體企業本身,也可以來自...

構建之法03

軟體開發是一種集體活動,其中必然面臨各成員間的協調 統一問題。銀行每天都要對各網點進行清算結賬,軟體開發也是一樣的,必須找到一種方法來衡量每天的工作,保證每天的工作能夠有效的持續下去,最終把軟體開發的過程變成一種內在的過程。這種方法就稱為每日構建或是持續整合。每日構建構建的過程是完全自動化的,通過預...