九九视频免费观看,久久久久久久久久免费视频,亚洲欧洲精品专线

我們在進行審計時注意的最后一個因素是使用API的開發人員的總體印象。

第1步：API源代碼分析、內部文檔和API審計計劃執行

API審核計劃包含以下內容：

編寫API業務和系統分析文檔及相關產品（文檔、示例、API注釋）。
用所謂的高級API描述語言編寫語義API描述。請注意，除了API規范之外，此任務還將包括靜態文檔項的編輯和轉換。
選擇可用的工具（或創建專用腳本）及其配置，以實現與API規范（見上文）和CI/CD的連接，從而自動化代碼/規范合規性驗證、生成交互式文檔和自動化測試。當代碼發生變化時，文檔也會發生變化，并進行自動測試，以證明文檔和API的符合性。

以下是對CI/CD流程的修改，其中包含了自動化驗證、測試和創建交互式文檔的新元素。這些行動不僅改善和加強了流程，自動化還會影響新功能的實施速度。

第2步：API改進

第三步：開發者中心

如何簡化API測試

我們選擇了5種測試方法，并使用元語言對其進行了描述。根據所選擇的概念，我們將能夠在CI/CD過程中包括文檔和API合規性驗證、自動測試或交互式文檔。為此，我們使用了：

API藍圖（用于web API的高級API描述語言），
Apary（作為API藍圖在線編輯器，用于創建交互式文檔），
Dredd for testing（一種語言識別命令行工具，用于根據API的后端實現驗證API描述文檔）。

Image 4: Screenshot that shows technical documentation about API services.

1.API藍圖

2.互動文件（Apiary）

下面的屏幕截圖顯示了文檔的主視圖。

Image 5: The screenshot presents the main view of the documentation.

簡介（包含快速入門），
參考文獻（API），
數據結構（對象描述）。

簡介部分包含有關如何設置一切以便能夠使用API的信息，例如，如何對系統進行身份驗證或注冊。參考部分包含API中所有可用資源的實際定義。每個對象都有自己的部分，其中包括一組指向每個方法定義的鏈接。數據結構部分包含作為API一部分的所有對象及其定義的列表，如參數和類型。

Image 6: The screenshot presents the Introduction section that contains the information how to set up everything to be able to use the API.

下面的屏幕截圖顯示了主文檔視圖，其中包含打開的調用方法詳細信息和嘗試控制臺面板。它顯示了URL、帶描述的URI參數、請求和標頭的標頭、示例正文和響應方案。

Image 7: The screenshot presents the main documentation view with an opened call method details and Try console panel. It shows the URL, URI parameters with description, headers for request and headers, example body, and scheme for response.

下面的屏幕截圖顯示了調用方法的詳細信息，可以生成許多流行編程語言的代碼示例（供您的應用程序使用）。這有助于促進通過API接口將任何應用程序或系統與API平臺集成的過程。可用的語言有cURL、Java、JavaScript、Node.js、Perl、Python、PHP、Ruby、Go、C#、Visual Basic、Groovy、Objective-C、Swift。

Image 8: The screenshot presents a call method details with a possibility to generate code examples (for the use in your application) in many popular programming languages.

下面的屏幕截圖顯示了嘗試控制臺面板，該面板提供了直接從文檔中測試API的機會。它允許我們放入自定義參數、標頭和正文，并向服務器創建完全自定義的請求。我們還可以通過模擬端點調用方法，這使我們能夠檢查API周圍的所有流量。

Image 9: The screenshot presents the Try console panel which offers an opportunity to test API directly from the documentation.

3.自動化API測試（Dredd）

Image 10: Dredd reads API description and step by step validates whether API implementation replies with responses as they are described in the documentation.