2. 程式人生 > >swagger註釋API詳細說明和示例

swagger註釋API詳細說明和示例

阿新 • • 發佈：2019-01-23
package com.chehejia.vl.api; import com.alibaba.fastjson.JSON; import com.chehejia.boot.starter.cache.CacheManager; import com.chehejia.framework.beans.model.Response; import com.chehejia.starter.ois.model.response.ResponseModel; import com.chehejia.starter.ois.service.OisClient; import com.chehejia.starter.ois.utils.OisUtil;
import com.chehejia.vl.domain.VlTransitionPlan; import com.chehejia.vl.domain.VlTransitionPlanItem; import com.chehejia.vl.enums.BillType; import com.chehejia.vl.enums.VLCacheKey; import com.chehejia.vl.model.AppLogInfo; import com.chehejia.vl.model.StatusCode; import com.chehejia.vl.model.transitionPlan.*;
import com.chehejia.vl.service.TransitionPlanMiniService; import com.chehejia.vl.utils.EmptyUtil; import com.chehejia.vl.utils.FastJsonUtils; import com.chehejia.vl.utils.SequenceUtil; import com.google.common.collect.Lists; import io.swagger.annotations.*; import lombok.AllArgsConstructor; import lombok.Getter
; import lombok.Setter; import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.util.Assert; import org.springframework.util.StringUtils; import org.springframework.web.bind.annotation.*; import org.springframework.web.multipart.MultipartFile; import org.springframework.web.multipart.support.StandardMultipartHttpServletRequest; import javax.servlet.http.HttpServletRequest; import java.text.ParseException; import java.text.SimpleDateFormat; import java.time.OffsetDateTime; import java.util.Arrays; import java.util.Collections; import java.util.List; @Slf4j @RestController @RequestMapping("/plan") public class TransitionPlanApi { @Autowired OisClient oisClient; @Autowired private TransitionPlanMiniService planService; @Autowired private CacheManager cacheManager; //呼叫介面 final boolean useService = true; //swagger預設初始化引數,必須定義成常量 class Contants{ private Contants(){}; public static final String planCode = "E10320180525154714001"; public static final String vin1 = "10000000000001999"; public static final String vin2 = "10000000000001998"; public static final String valCode = "1234"; } @ApiOperation("介面描述：[運輸端]校驗計劃對應的操作碼是否正確") @ApiResponses({ @ApiResponse(code = 0, message = "校驗成功"), @ApiResponse(code = 20001, message = "校驗失敗"), @ApiResponse(code = 40001, message = "引數不合法"), @ApiResponse(code = 50001, message = "系統異常"),}) @ApiImplicitParams({ @ApiImplicitParam(name = "planCode", value = "計劃編碼", required = true, defaultValue = Contants.planCode), @ApiImplicitParam(name = "valCode", value = "驗證碼", required = true, defaultValue = Contants.valCode), }) @RequestMapping(value = "/validate/{planCode}/{valCode}", method = RequestMethod.POST) public Response<Boolean> valiOperate(@PathVariable String planCode, @ApiParam("驗證碼") @PathVariable String valCode) { } @ApiOperation("介面描述：掃描車輛定位計劃與車輛驗車") @ApiResponses({ @ApiResponse(code = 0, message = "執行成功"), @ApiResponse(code = 20001, message = "查詢不到資料"), @ApiResponse(code = 40001, message = "引數不合法"), @ApiResponse(code = 50001, message = "系統異常"), }) @ApiImplicitParams({ @ApiImplicitParam(name = "vin", value = "VIN", required = true, defaultValue = Contants.vin1), }) @RequestMapping(value = "/scanPlan/{vin}", method = RequestMethod.POST) public Response<VV3> scanPlan(@PathVariable String vin) { } @ApiOperation("介面描述：掃描車輛進行驗車") @ApiResponses({ @ApiResponse(code = 0, message = "執行成功"), @ApiResponse(code = 20001, message = "查詢不到資料"), @ApiResponse(code = 40001, message = "引數不合法"), @ApiResponse(code = 50001, message = "系統異常"),}) @ApiImplicitParams({ @ApiImplicitParam(name = "planCode", value = "計劃編碼", required = true, defaultValue = Contants.planCode), @ApiImplicitParam(name = "vin", value = "VIN", required = true, defaultValue = Contants.vin1), }) @RequestMapping(value = "/scan/{planCode}/{vin}", method = RequestMethod.POST) public Response<VV3> valiVin(@PathVariable String planCode, @PathVariable String vin) { } @ApiOperation("介面描述：單獨上傳質損圖片") @ApiResponses({ @ApiResponse(code = 0, message = "執行成功"), @ApiResponse(code = 40001, message = "引數不合法"), @ApiResponse(code = 50001, message = "系統異常"), }) @ApiImplicitParams({ @ApiImplicitParam(name = "planCode", value = "計劃編碼", required = true, defaultValue = Contants.planCode), @ApiImplicitParam(name = "vin", value = "VIN", required = true, defaultValue = Contants.vin1), }) @RequestMapping(value = "/upload-damage/{planCode}/{vin}", method = RequestMethod.POST) public Response<String> uploadDamageImg(@PathVariable String planCode, @PathVariable String vin, HttpServletRequest request) { } @ApiOperation("介面描述：確認質損（下一步）") @ApiResponses({ @ApiResponse(code = 0, message = "執行成功"), @ApiResponse(code = 20001, message = "執行失敗"), @ApiResponse(code = 40001, message = "引數不合法"), @ApiResponse(code = 50001, message = "系統異常"), }) @ApiImplicitParams({ @ApiImplicitParam(name = "planCode", value = "計劃編號", required = true, defaultValue = Contants.planCode), @ApiImplicitParam(name = "vin", value = "vin", required = true, defaultValue = Contants.vin1), @ApiImplicitParam(name = "eleQuity", value = "電量", defaultValue = "100"), @ApiImplicitParam(name = "mileage", value = "公里數", defaultValue = "50"), @ApiImplicitParam(name = "otherDesc", value = "其他備註", defaultValue = "測試備註資訊"), @ApiImplicitParam(name = "damageInfo.veryBad", value = "是否嚴重事故", defaultValue = "true"), @ApiImplicitParam(name = "damageInfo.badPoint1", value = "質損部位1", defaultValue = "MLT2/MLB3"), @ApiImplicitParam(name = "damageInfo.badPoint2", value = "質損部位3", defaultValue = "MLT2/MLB3"), @ApiImplicitParam(name = "damageInfo.badPoint3", value = "質損部位3", defaultValue = "MLT2/MLB3"), @ApiImplicitParam(name = "damageInfo.imgs", value = "圖片id集合", defaultValue = "imageCode1,imageCode2,imageCode3"), @ApiImplicitParam(name = "damageInfo.damageDesc", value = "質損描述", defaultValue = "質損測試資料描述"), }) @RequestMapping(value = "/confirm-damage", method = RequestMethod.POST) public Response<Boolean> confirmDamageImg( DamageInfoAndDes damageInfoAndDes) { } @ApiOperation("介面描述：查詢計劃列表") @ApiResponses({ @ApiResponse(code = 0, message = "執行成功"), @ApiResponse(code = 40001, message = "引數不合法"), @ApiResponse(code = 50001, message = "系統異常"),}) @ApiImplicitParams({ @ApiImplicitParam(name = "planType", value = "計劃型別(10提車20交車)", required = true, defaultValue = "10"), @ApiImplicitParam(name = "date", value = "日期(格式：yyyy-MM-dd)"), @ApiImplicitParam(name = "dwCode", value = "道位編碼"), @ApiImplicitParam(name = "carNo", value = "車牌號"), }) @RequestMapping(value = "/query", method = RequestMethod.POST) public Response<List<TransionPlanInfo>> queryPlan(TransionPlanQuery query) { } @ApiOperation("介面描述：檢視計劃詳情") @ApiResponses({ @ApiResponse(code = 0, message = "執行成功"), @ApiResponse(code = 40001, message = "引數不合法"), @ApiResponse(code = 50001, message = "系統異常"),}) @ApiImplicitParams({ @ApiImplicitParam(name = "planCode", value = "計劃編碼", required = true, defaultValue = Contants.planCode), }) @RequestMapping(value = "/detail/{planCode}", method = RequestMethod.GET) public Response<TransionPlanInfoAndVin> lookPlanDetail(@PathVariable String planCode) { } }

相關推薦

swagger註釋API詳細說明和示例

package com.chehejia.vl.api; import com.alibaba.fastjson.JSON; import com.chehejia.boot.starter.cache.CacheManager; import com.chehejia.framework.beans.mod

swagger註釋API詳細說明

支持 描述 ons code PE ID markdown 字段 rem API詳細說明 註釋匯總 作用範圍API使用位置 對象屬性 @ApiModelProperty 用在出入參數對象的字段上 協議集描述 @Api 用於controller類上 協議

（轉發） swagger註釋API詳細說明

produce clas nbsp per restful val med ryu 當前 參考： https://blog.csdn.net/xupeng874395012/article/details/68946676　　https://blog.csdn.net/yi

Spring MVC中使用Swagger生成API文件和完整專案示例Demo，swagger

轉載自：http://www.360doc.com/content/17/0914/17/16915_687184334.shtml    實際專案中非常需要寫文件，提高Java服務端和Web前端以及移動端的對接效率。   聽說Swagger這

Spring MVC中使用Swagger生成API文件和完整專案示例Demo，swagger-server-api

package cn.fansunion.swagger.serverapi.controller; import org.springframework.http.MediaType; import org.springframework.stereotype.Controller; import org

Java ArrayList詳細介紹和使用示例

zab tco random class strong art vector 導致 執行 對ArrayList的整體認識 ArrayList是一個數組隊列，相當於動態數組。與Java中的數組相比，它的容量能動態增長。它繼承了AbstractList,實現了List，Rand

Java HashMap詳細介紹和使用示例（正在整理學習中）

trac blog null https 學習 ava abs 同步 .com 對HashMap的整體認識 HashMap是一個散列表，它存儲的內容是鍵值對（key-value）映射。 HashMap繼承於AbstractMap,實現了Map、Cloneable、jav

Laravel（PHP）使用Swagger生成API文件不完全指南 - 基本概念和環境搭建 - 簡書

在PHPer中，很多人聽說過Swagger，部分人知道Swagger是用來做API文件的，然而只有少數人真正知道怎麼正確使用Swagger，因為PHP界和Swagger相關的資料實在是太少了。所以鄙人斗膽一試，希望能以本文幫助到大家瞭解Swagger，從此告別成天用Word、Markdown折騰API文件的日

Laravel（PHP）使用Swagger生成API文檔不完全指南 - 基本概念和環境搭建 - 簡書

function 閱讀 編程語言 文字 formdata 自動 tom dev 開始 在PHPer中，很多人聽說過Swagger，部分人知道Swagger是用來做API文檔的，然而只有少數人真正知道怎麽正確使用Swagger，因為PHP界和Swagger相關的資料實在是太少

2018版阿里雲簡訊api使用教程，附詳細圖文和demo，可直接執行

      阿里雲簡訊介面改版後，原來的介面已不能使用，提供的新版demo晦澀難懂，文件也語焉不詳，多次與技術人員詢問後依然得不到正確使用姿勢，參考https://blog.csdn.net/u011958281/article/details/78614792 後總算

教你用webpack搭一個vue腳手架[超詳細講解和註釋！]

filename 結構 merge 擴展名 1.4 ats building package with 1.適用人群 1.對webpack知識有一定了解但不熟悉的同學. 2.女同學！！！(233333....) 2.目的 在自己對webpack有

【小家Spring】藉助Springfox整合Swagger（API介面神器）和SpringBoot

背景 隨著網際網路技術的發展，現在的網站架構基本都由原來的後端渲染，變成了：前端渲染、先後端分離的形態，而且前端技術和後端技術在各自的道路上越走越遠。 前端和後端的唯一聯絡，變成了API介面；API文件變成了前後端開發人員聯絡的紐帶，變得越來越重要，swagger就是一款讓你更好

grpc服務整合RESFful JSON API grpc-gateway和swagger-ui介面

閱讀時間：5min左右 本文目的： 說明如何使用grpc-gateway（下圖紅色部分）反向代理外掛將RESTful JSON API轉換為gRPC，並使用swagger ui提供rest api介面。 整合步驟： 上圖所示，由下往上 一、HelloWorl

TensorFlow Object Detection API 超詳細教程和踩坑過程（安裝）

目錄     cuda安裝     cudnn安裝     anaconda安裝並建立環境     tensorflow環境     Tensorflow.models下載     Protobuf配置與測試 1.配置環境       首先說一下我

TensorFlow Object Detection API 超詳細教程和踩坑過程（資料準備和訓練）

1.準備資料     object detection的資料是需要tfrecord格式的，但是一般我們還是先製作voc格式的資料更加方便。     1.voc格式資料的準備：github上下載一個label-img：    然後選擇VOC格式，開始漫長的資料

Swagger編寫API文件的YAML中文示例

#必要欄位！Swagger規範版本，必須填2.0，否則該YAML將不能用於Swagger其他元件 swagger: '2.0' #必要欄位！描述API介面資訊的元資料 info: #介面標題 title: swagger說明文件　 #介面文件的描述

javaweb專案中引入struts2後web.xml的詳細配置和註釋

web.xml是web應用中載入有關servlet資訊的重要配置檔案，起著初始化servlet,filter等web程式的作用。  通常，所有的MVC框架都需要Web應用載入一個核心控制器，那採取什麼方法載入這樣的核心控制器呢，servlet或filter成為了很好的選擇

django-rest-swagger對API介面註釋

Swagger是一個API開發者的工具框架，用於生成、描述、呼叫和視覺化RESTful風格的Web服務。總體目標是使客戶端和檔案系統伺服器以同樣的速度來更新，方法，引數和模型緊密整合到伺服器端的程式碼中，允許API始終保持同步。 在使用 django-rest-framework 進行API開發，可以使用d

django-rest-swagger對API接口註釋

port self. auth bubuko all 註意 image url sch Swagger是一個API開發者的工具框架，用於生成、描述、調用和可視化RESTful風格的Web服務。總體目標是使客戶端和文件系統服務器以同樣的速度來更新，方法，參數和模型緊密集成到服

Zookeeper 開源客戶端 ZkClient 版本 api介紹和示例

ZkClient是由Datameer的工程師開發的開源客戶端，對Zookeeper的原生API進行了包裝，實現了超時重連、Watcher反覆註冊等功能。 ZKClient版本及原始碼 maven依賴 ZkClient目前有兩個不同artifactId的系列。  其中最早