專案開發 介面開發API文件 常用的註解

2021-10-06 23:38:43 字數 1221 閱讀 8900

@data: 類註解,作用於實體類的setter和getter的生成,屬於lombok外掛程式中的註解,如果該字段被final修飾,則不會生成setter方法

@apimodel:類註解,作用於介面文件的實體類的描述

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

value–字段說明 

name–重寫屬性名字 

datatype–重寫屬性型別 

required–是否必填 

example–舉例說明 

hidden–隱藏

@service:service標註業務層元件,標註將這個類交給spring容器管理,spring容器要為他建立物件

@resource:預設按name注入,可以通過name和type屬性進行選擇性注入

@restcontroller:

1)類註解,相當於@responsebody + @controller合在一起的作用;

2)如果只是使用@controller註解controller,則controller中的方法無法返回jsp頁面,配置的視**析器internalresourceviewresolver不起作用,返回的內容就是return 裡的內容;

3)如果需要返回到指定頁面,則需要用 @controller配合視**析器internalresourceviewresolver才行;

4)如果需要返回json,xml或自定義mediatype內容到頁面,則需要在對應的方法上加上@responsebody註解。

類定義處:規定初步的請求對映,相對於web應用的根目錄;

方法定義處:進一步細分請求對映,相對於類定義處的url。如果類定義處沒有使用該註解,則方法標記的url相對於根目錄而言;

@api:類註解,用在controller上,對controller進行注釋;屬於swagger外掛程式中的註解

@autowired:屬性註解,預設按type注入

@apioperation:方法註解,用在api方法上,對該api做注釋,說明api的作用;屬於swagger外掛程式中的註解

@apiimplicitparams:方法註解,用來包含api的一組引數註解,可以簡單的理解為引數註解的集合宣告;屬於swagger外掛程式中的註解

@apiimplicitparam:方法註解,用在@apiimplicitparams註解中,也可以單獨使用,說明乙個請求引數的各個方面,該註解包含的常用選項有,資料swagger外掛程式中的註解

專案開發效率怎麼提高 圍繞API介面文件

最近和同行交流時也聽到乙個觀點 採用 文件驅動 的協作模式,比 先開發 後維護文件 和 口頭溝通確認 的方式,團隊協作效率和產品質量都能得到提高。因此在了解後,最近專案組找了個工具,嘗試基於文件來進行工作,使用有章可循的 文件驅動 方式來降低大量無意義的溝通成本。eolinker將 api 的狀態劃...

API 介面開發規範

api與使用者的通訊協議,總是使用https協議,確保互動資料的傳輸安全。應該盡量將api部署在專用網域名稱之下。如果確定api很簡單,不會有進一步擴充套件,可以考慮放在主網域名稱下。應該將api的版本號放入url。v 另一種做法是,將版本號放在http頭資訊中,但不如放入url方便和直觀。gith...

PHP開發API介面

在實際工作中,使用php寫api介面是經常做的,php寫好介面後,前台就可以通過鏈結獲取介面提供的資料,而返回的資料一般分為兩種情況,xml和json,在這個過程中,伺服器並不知道,請求的 是什麼,有可能是別人非法呼叫我們的介面,獲取資料,因此就要使用安全驗證。從圖中可以看得很清楚,前台想要呼叫介面...