ServiceComb中的“賣身協(xié)議”

Swagger是什么：

Swagger是一個用于描述和記錄RESTful APIs的項目(參考文檔：https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md)。

Swagger的表現(xiàn)形式

根據(jù)Swagger規(guī)范描述的RESTful API的文件被表示為JSON對象并符合JSON標準。?作為JSON超集的YAML也可以用來表示Swagger規(guī)范文件，如：

字段名稱簡介

指定使用的Swagger規(guī)格版本。 它可以被Swagger UI和其他客戶端用來解釋API列表。 該值必須是“2.0”

與consumer類似

安全方案定義

額外的 外部文件

注：標紅字段必須填寫

一些MIME類型的定義：

text/plain;?charset=utf-8 ??application/json ??application/vnd.github+json ??application/vnd.github.v3+json ??application/vnd.github.v3.raw+json ??application/vnd.github.v3.text+json ??application/vnd.github.v3.html+json ??application/vnd.github.v3.full+json ??application/vnd.github.v3.diff ??application/vnd.github.v3.patch

Swagger中定義的參數(shù)類型

1.Path

2.Query

3.Header

4.Body

5.Form

If?in?is?"body":

這里要注意，如果參數(shù)類型為"body",則不能按下圖所示書寫

正確的寫法是將類型寫在Schema Object下，如：

在實際開發(fā)中很容易出現(xiàn)此錯誤

Swagger提供的一些注解

swagger-core提供了一系列的注解來達到生成生成契約文檔(Swagger documentation)的目的，這些注解分為三大類：

聲明資源

聲明一個方法

聲明API模型。

下面列舉了一些swagger-core提供的注解及其作用

在Swagger 2.0，class不再是一個resource，而是一個tag。@Api也被用來定義class中的所有方法，不再是用來聲明resource。

TCP/IP API

版權聲明：本文內(nèi)容由網(wǎng)絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實后本網(wǎng)站將在24小時內(nèi)刪除侵權內(nèi)容。

版權聲明：本文內(nèi)容由網(wǎng)絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實后本網(wǎng)站將在24小時內(nèi)刪除侵權內(nèi)容。