亚洲99在线的,国产又爽又黄又刺激的软件,两性色午夜视频免费老司机

我們?cè)谶M(jìn)行審計(jì)時(shí)注意的最后一個(gè)因素是使用API的開發(fā)人員的總體印象。

第1步：API源代碼分析、內(nèi)部文檔和API審計(jì)計(jì)劃執(zhí)行

API審核計(jì)劃包含以下內(nèi)容：

編寫API業(yè)務(wù)和系統(tǒng)分析文檔及相關(guān)產(chǎn)品（文檔、示例、API注釋）。
用所謂的高級(jí)API描述語(yǔ)言編寫語(yǔ)義API描述。請(qǐng)注意，除了API規(guī)范之外，此任務(wù)還將包括靜態(tài)文檔項(xiàng)的編輯和轉(zhuǎn)換。
選擇可用的工具（或創(chuàng)建專用腳本）及其配置，以實(shí)現(xiàn)與API規(guī)范（見上文）和CI/CD的連接，從而自動(dòng)化代碼/規(guī)范合規(guī)性驗(yàn)證、生成交互式文檔和自動(dòng)化測(cè)試。當(dāng)代碼發(fā)生變化時(shí)，文檔也會(huì)發(fā)生變化，并進(jìn)行自動(dòng)測(cè)試，以證明文檔和API的符合性。

以下是對(duì)CI/CD流程的修改，其中包含了自動(dòng)化驗(yàn)證、測(cè)試和創(chuàng)建交互式文檔的新元素。這些行動(dòng)不僅改善和加強(qiáng)了流程，自動(dòng)化還會(huì)影響新功能的實(shí)施速度。

第2步：API改進(jìn)

第三步：開發(fā)者中心

如何簡(jiǎn)化API測(cè)試

我們選擇了5種測(cè)試方法，并使用元語(yǔ)言對(duì)其進(jìn)行了描述。根據(jù)所選擇的概念，我們將能夠在CI/CD過程中包括文檔和API合規(guī)性驗(yàn)證、自動(dòng)測(cè)試或交互式文檔。為此，我們使用了：

API藍(lán)圖（用于web API的高級(jí)API描述語(yǔ)言），
Apary（作為API藍(lán)圖在線編輯器，用于創(chuàng)建交互式文檔），
Dredd for testing（一種語(yǔ)言識(shí)別命令行工具，用于根據(jù)API的后端實(shí)現(xiàn)驗(yàn)證API描述文檔）。

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

1.API藍(lán)圖

2.互動(dòng)文件（Apiary）

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

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

簡(jiǎn)介（包含快速入門），
參考文獻(xiàn)（API），
數(shù)據(jù)結(jié)構(gòu)（對(duì)象描述）。

簡(jiǎn)介部分包含有關(guān)如何設(shè)置一切以便能夠使用API的信息，例如，如何對(duì)系統(tǒng)進(jìn)行身份驗(yàn)證或注冊(cè)。參考部分包含API中所有可用資源的實(shí)際定義。每個(gè)對(duì)象都有自己的部分，其中包括一組指向每個(gè)方法定義的鏈接。數(shù)據(jù)結(jié)構(gòu)部分包含作為API一部分的所有對(duì)象及其定義的列表，如參數(shù)和類型。

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

下面的屏幕截圖顯示了主文檔視圖，其中包含打開的調(diào)用方法詳細(xì)信息和嘗試控制臺(tái)面板。它顯示了URL、帶描述的URI參數(shù)、請(qǐng)求和標(biāo)頭的標(biāo)頭、示例正文和響應(yīng)方案。

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.

下面的屏幕截圖顯示了調(diào)用方法的詳細(xì)信息，可以生成許多流行編程語(yǔ)言的代碼示例（供您的應(yīng)用程序使用）。這有助于促進(jìn)通過API接口將任何應(yīng)用程序或系統(tǒng)與API平臺(tái)集成的過程。可用的語(yǔ)言有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.

下面的屏幕截圖顯示了嘗試控制臺(tái)面板，該面板提供了直接從文檔中測(cè)試API的機(jī)會(huì)。它允許我們放入自定義參數(shù)、標(biāo)頭和正文，并向服務(wù)器創(chuàng)建完全自定義的請(qǐng)求。我們還可以通過模擬端點(diǎn)調(diào)用方法，這使我們能夠檢查API周圍的所有流量。

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

3.自動(dòng)化API測(cè)試（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.

下面的截圖以更易讀的形式展示了Dredd測(cè)試結(jié)果。它們包含所有方法調(diào)用的報(bào)告，包括錯(cuò)誤（如果發(fā)生）、請(qǐng)求或響應(yīng)中的任何不一致，以及其他有價(jià)值的信息，這些信息可以幫助調(diào)查API的問題。Dredd還可以與任何CI/CD工具連接，當(dāng)任何更改應(yīng)用于代碼時(shí)，該工具會(huì)自動(dòng)運(yùn)行測(cè)試。

Image 11: The screenshot presents the Dredd test results in a more readable form.

API審核：最重要的

文檔是任何API的重要組成部分。沒有它，就很難找出可用的端點(diǎn)、它們的用途以及我們可以使用的參數(shù)。這種交互式文檔不僅允許我們查看可用的端點(diǎn)、它們的參數(shù)或返回值的方案，還允許我們嘗試它們。這不僅有助于找到特定的資源，而且有助于根據(jù)請(qǐng)求調(diào)用它，這在開發(fā)過程中往往很有用。

文章轉(zhuǎn)自: https://deviniti.com/blog/software-engineering/how-to-audit-api-step-by-step/