SWAGGERPETSTORE概览描述.docx
《SWAGGERPETSTORE概览描述.docx》由会员分享，可在线阅读，更多相关《SWAGGERPETSTORE概览描述.docx（19页珍藏版）》请在冰豆网上搜索。
SWAGGERPETSTORE概览描述
SwaggerPetstore
1.概览
1.1.描述
ThisisasampleserverPetstoreserver.YoucanfindoutmoreaboutSwaggerat[]（）oron[,#swagger]（）.Forthissample,youcanusetheapikey`special-key`totesttheauthorizationfilters.
1.2.版本
1.0.3
1.3.联系人
1.4.许可证
Apache2.0
2.接口列表
2.1.pet
EverythingaboutyourPets
2.1.1.FindpetbyID
GET/pet/{petId}
描述
Returnsasinglepet
Produces
∙application/json
∙application/xml
Consumes
无
参数
参数类型
参数名
描述
数据类型
path
petId*
必填
IDofpettoreturn
integer
返回值
响应码
描述
数据类型
200
successfuloperation
Pet
400
InvalidIDsupplied
404
Petnotfound
2.1.2.Updatesapetinthestorewithformdata
POST/pet/{petId}
描述
Updatesapetinthestorewithformdata
Produces
∙application/json
∙application/xml
Consumes
∙application/x-www-form-urlencoded
参数
参数类型
参数名
描述
数据类型
path
petId*
必填
IDofpetthatneedstobeupdated
integer
formData
name
Updatednameofthepet
string
formData
status
Updatedstatusofthepet
string
返回值
响应码
描述
数据类型
405
Invalidinput
2.1.3.Deletesapet
DELETE/pet/{petId}
描述
Deletesapet
Produces
∙application/json
∙application/xml
Consumes
无
参数
参数类型
参数名
描述
数据类型
header
api_key
string
path
petId*
必填
Petidtodelete
integer
返回值
响应码
描述
数据类型
400
InvalidIDsupplied
404
Petnotfound
2.1.4.uploadsanimage
POST/pet/{petId}/uploadImage
描述
uploadsanimage
Produces
∙application/json
Consumes
∙multipart/form-data
参数
参数类型
参数名
描述
数据类型
path
petId*
必填
IDofpettoupdate
integer
formData
additionalMetadata
Additionaldatatopasstoserver
string
formData
file
filetoupload
file
返回值
响应码
描述
数据类型
200
successfuloperation
ApiResponse
2.1.5.Updateanexistingpet
PUT/pet
描述
Updateanexistingpet
Produces
∙application/json
∙application/xml
Consumes
∙application/json
∙application/xml
参数
参数类型
参数名
描述
数据类型
body
body*
必填
Petobjectthatneedstobeaddedtothestore
Pet
返回值
响应码
描述
数据类型
400
InvalidIDsupplied
404
Petnotfound
405
Validationexception
2.1.6.Addanewpettothestore
POST/pet
描述
Addanewpettothestore
Produces
∙application/json
∙application/xml
Consumes
∙application/json
∙application/xml
参数
参数类型
参数名
描述
数据类型
body
body*
必填
Petobjectthatneedstobeaddedtothestore
Pet
返回值
响应码
描述
数据类型
405
Invalidinput
2.1.7.FindsPetsbystatus
GET/pet/findByStatus
描述
Multiplestatusvaluescanbeprovidedwithcommaseparatedstrings
Produces
∙application/json
∙application/xml
Consumes
无
参数
参数类型
参数名
描述
数据类型
query
status*
必填
Statusvaluesthatneedtobeconsideredforfilter
array（multi）
返回值
响应码
描述
数据类型
200
successfuloperation
array
400
Invalidstatusvalue
2.1.8.FindsPetsbytags
GET/pet/findByTags
描述
Multipletagscanbeprovidedwithcommaseparatedstrings.Usetag1,tag2,tag3fortesting.
Produces
∙application/json
∙application/xml
Consumes
无
参数
参数类型
参数名
描述
数据类型
query
tags*
必填
Tagstofilterby
array（multi）
返回值
响应码
描述
数据类型
200
successfuloperation
array
400
Invalidtagvalue
2.2.store
AccesstoPetstoreorders
2.2.1.Returnspetinventoriesbystatus
GET/store/inventory
描述
Returnsamapofstatuscodestoquantities
Produces
∙application/json
Consumes
无
参数
参数类型
参数名
描述
数据类型
返回值
响应码
描述
数据类型
200
successfuloperation
object
2.2.2.FindpurchaseorderbyID
GET/store/order/{orderId}
描述
ForvalidresponsetryintegerIDswithvalue>=1and<=10.Othervalueswillgeneratedexceptions
Produces
∙application/json
∙application/xml
Consumes
无
参数
参数类型
参数名
描述
数据类型
path
orderId*
必填
IDofpetthatneedstobefetched
integer
返回值
响应码
描述
数据类型
200
successfuloperation
Order
400
InvalidIDsupplied
404
Ordernotfound
2.2.3.DeletepurchaseorderbyID
DELETE/store/order/{orderId}
描述
ForvalidresponsetryintegerIDswithpositiveintegervalue.Negativeornon-integervalueswillgenerateAPIerrors
Produces
∙application/json
∙application/xml
Consumes
无
参数
参数类型
参数名
描述
数据类型
path
orderId*
必填
IDoftheorderthatneedstobedeleted
integer
返回值
响应码
描述
数据类型
400
InvalidIDsupplied
404
Ordernotfound
2.2.4.Placeanorderforapet
POST/store/order
描述
Placeanorderforapet
Produces
∙application/json
∙application/xml
Consumes
∙application/json
参数
参数类型
参数名
描述
数据类型
body
body*
必填
orderplacedforpurchasingthepet
Order
返回值
响应码
描述
数据类型
200
successfuloperation
Order
400
InvalidOrder
2.3.user
Operationsaboutuser
2.3.1.Getuserbyusername
GET/user/{username}
描述
Getuserbyusername
Produces
∙application/json
∙application/xml
Consumes
无
参数
参数类型
参数名
描述
数据类型
path
username*
必填
Thenamethatneedstobefetched.Useuser1fortesting.
string
返回值
响应码
描述
数据类型
200
successfuloperation
User
400
Invalidusernamesupplied
404
Usernotfound
2.3.2.Updateduser
PUT/user/{username}
描述
Thiscanonlybedonebytheloggedinuser.
Produces
∙application/json
∙application/xml
Consumes
∙application/json
参数
参数类型
参数名
描述
数据类型
path
username*
必填
namethatneedtobeupdated
string
body
body*
必填
Updateduserobject
User
返回值
响应码
描述
数据类型
400
Invalidusersupplied
404
Usernotfound
2.3.3.Deleteuser
DELETE/user/{username}
描述
Thiscanonlybedonebytheloggedinuser.
Produces
∙application/json
∙application/xml
Consumes
无
参数
参数类型
参数名
描述
数据类型
path
username*
必填
Thenamethatneedstobedeleted
string
返回值
响应码
描述
数据类型
400
Invalidusernamesupplied
404
Usernotfound
2.3.4.Logsuserintothesystem
GET/user/login
描述
Logsuserintothesystem
Produces
∙application/json
∙application/xml
Consumes
无
参数
参数类型
参数名
描述
数据类型
query
username*
必填
Theusernameforlogin
string
query
password*
必填
Thepasswordforloginincleartext
string
返回值
响应码
描述
数据类型
200
successfuloperation
X-Expires-After（string）:
dateinUTCwhentokenexpires
X-Rate-Limit（integer）:
callsperhourallowedbytheuser
string
400
Invalidusername/passwordsupplied
2.3.5.Logsoutcurrentloggedinusersession
GET/user/logout
描述
Logsoutcurrentloggedinusersession
Produces
∙application/json
∙application/xml
Consumes
无
参数
参数类型
参数名
描述
数据类型
返回值
响应码
描述
数据类型
default
successfuloperation
2.3.6.Createuser
POST/user
描述
Thiscanonlybedonebytheloggedinuser.
Produces
∙application/json
∙application/xml
Consumes
∙application/json
参数
参数类型
参数名
描述
数据类型
body
body*
必填
Createduserobject
User
返回值
响应码
描述
数据类型
default
successfuloperation
2.3.7.Createslistofuserswithgiveninputarray
POST/user/createWithArray
描述
Createslistofuserswithgiveninputarray
Produces
∙application/json
∙application/xml
Consumes
∙application/json
参数
参数类型
参数名
描述
数据类型
body
body*
必填
Listofuserobject
array
返回值
响应码
描述
数据类型
default
successfuloperation
2.3.8.Createslistofuserswithgiveninputarray
POST/user/createWithList
描述
Createslistofuserswithgiveninputarray
Produces
∙application/json
∙application/xml
Consumes
∙application/json
参数
参数类型
参数名
描述
数据类型
body
body*
必填
Listofuserobject
array
返回值
响应码
描述
数据类型
default
successfuloperation
3.数据模型
3.1.Category
3.1.1.属性
属性名
描述
类型
id
integer
name
string
3.1.2.示例
{
"id":
0,
"name":
"string"
}
3.2.Pet
3.2.1.属性
属性名
描述
类型
id
integer
category
Category
name*
string
photoUrls*
array
tags
array
status
petstatusinthestore
string
3.2.2.示例
{
"id":
0,
"category":
{
"id":
0,
"name":
"string"
},
"name":
"string",
"photoUrls":
[
"string"
],
"tags":
[
{
"id":
0,
"name":
"string"
}
],
"status":
"string"
}
3.3.Tag
3.3.1.属性
属性名
描述
类型
id
integer
name
string
3.3.2.示例
{
"id":
0,
"name":
"string"
}
3.4.ApiResponse
3.4.1.属性
属性名
描述
类型
code
integer
type
string
message
string
3.4.2.示例
{
"code":
0,
"type":
"string",
"message":
"string"
}
3.5.Order
3.5.1.属性
属性名
描述
类型
id
integer
petId
integer
quantity
integer
shipDate
string
status
OrderStatus
string
complete
boolean
3.5.2.示例
{
"id":
0,
"petId":
0,
"quantity":
0,
"shipDate":
"string",
"status":
"string",
"complete":
false
}
3.6.User
3.6.1.属性
属性名
描述
类型
id
integer
username
string
firstName
string
lastName
string
email
string
password
string
phone
string
userStatus
UserStatus
integer
3.6.2.示例
{
"id":
0,
"username":
"string",
"firstName":
"string",
"lastName":
"string",
"email":
"string",
"password":
"string",
"phone":
"string",
"userStatus":
0
}
4.关于文档
本文档由poi-tlWord模板引擎（）生成，poi-tl是一个免费开源的Java类库，你可以非常方便的加入到你的Java项目中。
升级会员 