還在糾結介面文件的事兒呢?

2021-10-11 03:11:36 字數 705 閱讀 6383

現在開發都要用到介面文件。不寫的話**不知道怎麼維護,寫的話又費時費力,更煩人的是有時候寫完了前端還要來問這個引數那個引數,真的苦不堪言。 在前後端分離的近幾年,寫介面文件對我來說是老大難,後面特地去查了自動化工具的理論,才茅塞頓開。至少對於寫文件的思路清晰了許多! 那麼現在就來分享一下我怎麼做的吧!

我們的目標,是寫出清晰簡練的文件。所以,首先我們要確定:怎麼才是清晰簡練的文件。 如下圖所示:

首先,讓你知道它的功能,引數,一目了然; 其次,你輸入引數就能馬上看到結果。

我希望的是在完成**後,可以費很少的力氣,就生成乙個像上圖所示的可除錯文件。 那麼接下來要做兩件事: 1、自動生成視覺化的文件; 2、文件可除錯。

一是可以直接在工具裡完成整個專案,二是匯出不同格式的專案文件,可用於其他文件工具。

我實現的工具是eolinker 使用位址是:www.eolinker.com 類似的工具有很多, swagger editor,gwsee,apidoc,都還可以。 寫這篇文章不是推薦什麼工具,但是自己走過一遍,肯定會有收穫哈哈:)

零基礎的你還在糾結怎麼學習Python程式設計嗎?

如果你是零基礎,又暫時沒有明確的目標,那麼可以先從簡單的python語言入手。為什麼要學習python?python容易學 程式設計對於任何乙個新手來說都不是一件容易的事情,特別是在中國基本以c語言作為啟蒙語言的國家。python對於任何乙個想學習的程式設計的人來說的確是乙個福音,閱讀python ...

介面文件的編寫

二 為什麼要寫介面文件?1 專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發 2 專案維護中或者專案人員更迭,方便後期人員檢視 維護 三 介面規範是什麼?首先介面分為四部分 方法 uri 請求引數 返回引數 1 方法 新增 post 修改 put 刪除 delete 獲取 get 2 ur...

介面測試入門,介面文件的分析

1.首先最主要的就是要分析介面測試文件,每乙個公司的測試文件都是不一樣的。具體的就要根據自己公司的介面而定,裡面缺少的內容自己需要與開發進行確認。我認為一針對於測試而言的主要的介面測試文件應該包含的內容分為以下幾個方面。a.具體的乙個業務實現的邏輯 b.請求的乙個方式 例如 請求方式為 http h...