go語(yǔ)言接口生成文檔 golang 接口文檔

Go語(yǔ)言文件操作

本文主要介紹了Go語(yǔ)言中文件讀寫(xiě)的相關(guān)操作。

創(chuàng)新互聯(lián)公司-專業(yè)網(wǎng)站定制、快速模板網(wǎng)站建設(shè)、高性價(jià)比新鄉(xiāng)網(wǎng)站開(kāi)發(fā)、企業(yè)建站全套包干低至880元,成熟完善的模板庫(kù),直接使用。一站式新鄉(xiāng)網(wǎng)站制作公司更省心,省錢,快速模板網(wǎng)站建設(shè)找我們，業(yè)務(wù)覆蓋新鄉(xiāng)地區(qū)。費(fèi)用合理售后完善，十多年實(shí)體公司更值得信賴。

文件是什么？

計(jì)算機(jī)中的文件是存儲(chǔ)在外部介質(zhì)（通常是磁盤）上的數(shù)據(jù)集合，文件分為文本文件和二進(jìn)制文件。

os.Open() 函數(shù)能夠打開(kāi)一個(gè)文件，返回一個(gè) *File 和一個(gè) err 。對(duì)得到的文件實(shí)例調(diào)用 close() 方法能夠關(guān)閉文件。

為了防止文件忘記關(guān)閉，我們通常使用defer注冊(cè)文件關(guān)閉語(yǔ)句。

Read方法定義如下：

它接收一個(gè)字節(jié)切片，返回讀取的字節(jié)數(shù)和可能的具體錯(cuò)誤，讀到文件末尾時(shí)會(huì)返回 0 和 io.EOF 。 舉個(gè)例子：

使用for循環(huán)讀取文件中的所有數(shù)據(jù)。

bufio是在file的基礎(chǔ)上封裝了一層API，支持更多的功能。

io/ioutil 包的 ReadFile 方法能夠讀取完整的文件，只需要將文件名作為參數(shù)傳入。

os.OpenFile() 函數(shù)能夠以指定模式打開(kāi)文件，從而實(shí)現(xiàn)文件寫(xiě)入相關(guān)功能。

其中：

name ：要打開(kāi)的文件名 flag ：打開(kāi)文件的模式。 模式有以下幾種：

perm ：文件權(quán)限，一個(gè)八進(jìn)制數(shù)。r（讀）04，w（寫(xiě)）02，x（執(zhí)行）01。

Go語(yǔ)言命令行利器cobra使用教程

cobra是一個(gè)提供簡(jiǎn)單接口來(lái)創(chuàng)建強(qiáng)大的現(xiàn)代CLI界面的庫(kù)類似git git tools，cobra也是一個(gè)應(yīng)用程序，它會(huì)生成你的應(yīng)用程序的腳手架來(lái)快速開(kāi)發(fā)基于cobra的應(yīng)用程序

cobra提供：

cobra建立在命令、參數(shù)、標(biāo)志的結(jié)構(gòu)之上

commands代表動(dòng)作，args是事物，flags是動(dòng)作的修飾符

最好的應(yīng)用程序在使用時(shí)讀起來(lái)就像句子，因此，用戶直觀地知道如何與它們交互

模式如下：APPNAME VERB NOUN --ADJECTIVE. or APPNAME COMMAND ARG --FLAG（APPNAME 動(dòng)詞 名詞 形容詞 或者 APPNAME 命令 參數(shù) 標(biāo)志）

一些真實(shí)世界的好例子可以更好地說(shuō)明這一點(diǎn)

kubectl 命令更能體現(xiàn)APPNAME 動(dòng)詞 名詞 形容詞

如下的例子，server 是command，port是flag

這個(gè)命令中，我們告訴git 克隆url

命令是應(yīng)用程序的中心點(diǎn)，應(yīng)用程序支持的每一個(gè)交互都包含在一個(gè)命令中，命令可以有子命令，也可以運(yùn)行操作

在上面的例子中，server是命令

更多關(guān)于cobra.Command

flag是一種修改命令行為的方式，cobra支持完全兼容POSIX標(biāo)志，也支持go flag package，cobra可以定義到子命令上的標(biāo)志，也可以僅對(duì)該命令可用的標(biāo)志

在上面的命令中，port是標(biāo)志

標(biāo)志的功能由 pflag library 提供，pflag library是flag標(biāo)準(zhǔn)庫(kù)的一個(gè)分支，在添加POSIX兼容性的同時(shí)維護(hù)相同的接口。

使用cobra很簡(jiǎn)單，首先，使用go get按照最新版本的庫(kù)，這個(gè)命令會(huì)安裝cobra可執(zhí)行程序以及庫(kù)和依賴項(xiàng)

下一步，引入cobra到應(yīng)用程序中

雖然歡迎您提供自己的組織，但通?；贑obra的應(yīng)用程序?qū)⒆裱韵陆M織結(jié)構(gòu)：

在Cobra應(yīng)用程序中，main.go文件通常非常簡(jiǎn)單。它有一個(gè)目的：初始化Cobra。

使用cobra生成器

cobra提供了程序用來(lái)創(chuàng)建你的應(yīng)用程序然后添加你想添加的命令，這是將cobra引入應(yīng)用程序最簡(jiǎn)單的方式

這兒 你可以發(fā)現(xiàn)關(guān)于cobra的更多信息

要手動(dòng)實(shí)現(xiàn)cobra，需要?jiǎng)?chuàng)建一個(gè)main.go 和rootCmd文件，可以根據(jù)需要提供其他命令

Cobra不需要任何特殊的構(gòu)造器。只需創(chuàng)建命令。

理想情況下，您可以將其放在app/cmd/root.go中：

在init（）函數(shù)中定義標(biāo)志和處理配置

例子如下，cmd/root.go:

創(chuàng)建main.go

使用root命令，您需要讓主函數(shù)執(zhí)行它。為清楚起見(jiàn)，Execute應(yīng)該在根目錄下運(yùn)行，盡管它可以在任何命令上調(diào)用。

在Cobra應(yīng)用程序中，main.go文件通常非常簡(jiǎn)單。它有一個(gè)目的：初始化Cobra。

可以定義其他命令，通常每個(gè)命令在cmd/目錄中都有自己的文件。

如果要?jiǎng)?chuàng)建版本命令，可以創(chuàng)建cmd/version.go并用以下內(nèi)容填充它：

如果希望將錯(cuò)誤返回給命令的調(diào)用者，可以使用RunE。

然后可以在execute函數(shù)調(diào)用中捕獲錯(cuò)誤。

標(biāo)志提供修飾符來(lái)控制操作命令的操作方式。

由于標(biāo)志是在不同的位置定義和使用的，因此我們需要在外部定義一個(gè)具有正確作用域的變量來(lái)分配要使用的標(biāo)志。

有兩種不同的方法來(lái)分配標(biāo)志。

標(biāo)志可以是“持久”的，這意味著該標(biāo)志將可用于分配給它的命令以及該命令下的每個(gè)命令。對(duì)于全局標(biāo)志，在根上指定一個(gè)標(biāo)志作為持久標(biāo)志。

也可以在本地分配一個(gè)標(biāo)志，該標(biāo)志只應(yīng)用于該特定命令。

默認(rèn)情況下，Cobra只解析目標(biāo)命令上的本地標(biāo)志，而忽略父命令上的任何本地標(biāo)志。通過(guò)啟用Command.TraverseChildren，Cobra將在執(zhí)行目標(biāo)命令之前解析每個(gè)命令上的本地標(biāo)志。

使用viper綁定標(biāo)志

在本例中，持久標(biāo)志author與viper綁定。注意：當(dāng)用戶未提供--author標(biāo)志時(shí)，變量author將不會(huì)設(shè)置為config中的值。

更多關(guān)于 viper的文檔

Flags默認(rèn)是可選的，如果希望命令在未設(shè)置標(biāo)志時(shí)報(bào)告錯(cuò)誤，請(qǐng)根據(jù)需要進(jìn)行標(biāo)記：

持久性Flags

可以使用命令的Args字段指定位置參數(shù)的驗(yàn)證。

內(nèi)置了以下驗(yàn)證器：

在下面的示例中，我們定義了三個(gè)命令。兩個(gè)是頂級(jí)命令，一個(gè)（cmdTimes）是頂級(jí)命令之一的子命令。在這種情況下，根是不可執(zhí)行的，這意味著需要一個(gè)子命令。這是通過(guò)不為“rootCmd”提供“Run”來(lái)實(shí)現(xiàn)的。

我們只為一個(gè)命令定義了一個(gè)標(biāo)志。

有關(guān)標(biāo)志的更多文檔，請(qǐng)?jiān)L問(wèn)

對(duì)于一個(gè)更完整的例子更大的應(yīng)用程序，請(qǐng)檢查 Hugo 。

當(dāng)您有子命令時(shí)，Cobra會(huì)自動(dòng)將help命令添加到應(yīng)用程序中。當(dāng)用戶運(yùn)行“應(yīng)用程序幫助”時(shí)，將調(diào)用此函數(shù)。此外，help還支持所有其他命令作為輸入。例如，您有一個(gè)名為“create”的命令，沒(méi)有任何附加配置；調(diào)用“app help create”時(shí)，Cobra將起作用。每個(gè)命令都會(huì)自動(dòng)添加“-help”標(biāo)志。

以下輸出由Cobra自動(dòng)生成。除了命令和標(biāo)志定義之外，不需要任何東西。

幫助就像其他命令一樣。它周圍沒(méi)有特殊的邏輯或行為。事實(shí)上，你可以提供你想提供的。

您可以為默認(rèn)命令提供自己的幫助命令或模板，以用于以下功能：

當(dāng)用戶提供無(wú)效的標(biāo)志或無(wú)效的命令時(shí)，Cobra通過(guò)向用戶顯示“用法”來(lái)響應(yīng)。

你可以從上面的幫助中認(rèn)識(shí)到這一點(diǎn)。這是因?yàn)槟J(rèn)幫助將用法作為其輸出的一部分嵌入。

您可以提供自己的使用函數(shù)或模板供Cobra使用。與幫助一樣，函數(shù)和模板也可以通過(guò)公共方法重寫(xiě)：

如果在root命令上設(shè)置了version字段，Cobra會(huì)添加一個(gè)頂級(jí)的'--version'標(biāo)志。運(yùn)行帶有“-version”標(biāo)志的應(yīng)用程序?qū)⑹褂冒姹灸０鍖姹敬蛴〉綐?biāo)準(zhǔn)輸出?？梢允褂胏md.SetVersionTemplate（s string）函數(shù)自定義模板。

可以在命令的主運(yùn)行函數(shù)之前或之后運(yùn)行函數(shù)。PersistentPreRun和PreRun函數(shù)將在運(yùn)行之前執(zhí)行。PersistentPostRun和PostRun將在運(yùn)行后執(zhí)行。如果子函數(shù)不聲明自己的函數(shù)，則它們將繼承Persistent*Run函數(shù)。這些函數(shù)按以下順序運(yùn)行：

輸出：

當(dāng)發(fā)生“未知命令”錯(cuò)誤時(shí)，Cobra將打印自動(dòng)建議。這使得Cobra在發(fā)生拼寫(xiě)錯(cuò)誤時(shí)的行為類似于git命令。例如：

基于注冊(cè)的每個(gè)子命令和Levenshtein距離的實(shí)現(xiàn)，建議是自動(dòng)的。匹配最小距離2（忽略大小寫(xiě)）的每個(gè)已注冊(cè)命令都將顯示為建議。

如果需要在命令中禁用建議或調(diào)整字符串距離，請(qǐng)使用：

or

您還可以使用SuggestFor屬性顯式設(shè)置將為其建議給定命令的名稱。這允許對(duì)在字符串距離方面不接近的字符串提供建議，但在您的一組命令中是有意義的，并且對(duì)于某些您不需要?jiǎng)e名的字符串。例子：

Cobra可以基于子命令、標(biāo)志等生成文檔。請(qǐng)?jiān)?docs generation文檔 中閱讀更多關(guān)于它的信息。

Cobra可以為以下shell生成shell完成文件：bash、zsh、fish、PowerShell。如果您在命令中添加更多信息，這些補(bǔ)全功能將非常強(qiáng)大和靈活。在 Shell Completions 中閱讀更多關(guān)于它的信息。

Cobra is released under the Apache 2.0 license. See LICENSE.txt

go語(yǔ)言框架gin之集成swagger

1.先安裝Go對(duì)應(yīng)的開(kāi)源Swagger相關(guān)的庫(kù)

go get?github點(diǎn)抗 /swaggo/swag/cmd/swag

go get github點(diǎn)抗 /swaggo/gin-swagger

go get?github點(diǎn)抗 /swaggo/files

go get?github點(diǎn)抗 /alecthomas/template

2.驗(yàn)證是否安裝成功：swag -v

3.針對(duì)接口寫(xiě)入注解

// @Summary 獲取多個(gè)標(biāo)簽

// @Tags 標(biāo)簽

// @Produce? json

// @Param name query string false "標(biāo)簽名稱" maxlength(100)

// @Param state query int false "狀態(tài)" Enums(0, 1) default(1)

// @Param page query int false "頁(yè)碼"

// @Param page_size query int false "每頁(yè)數(shù)量"

// @Success 200 {object} model.TagSwagger "成功"

// @Failure 400 {object} errcode.Error "請(qǐng)求錯(cuò)誤"

// @Failure 500 {object} errcode.Error "內(nèi)部錯(cuò)誤"

// @Router /api/v1/tags [get]

func (t Tag) List(c *gin.Context) {

}

// @Summary 新增標(biāo)簽

// @Tags 標(biāo)簽

// @Produce? json

// @Param name body string true "標(biāo)簽名稱" minlength(3) maxlength(100)

// @Param state body int false "狀態(tài)" Enums(0, 1) default(1)

// @Param created_by body string false "創(chuàng)建者" minlength(3) maxlength(100)

// @Success 200 {object} model.Tag "成功"

// @Failure 400 {object} errcode.Error "請(qǐng)求錯(cuò)誤"

// @Failure 500 {object} errcode.Error "內(nèi)部錯(cuò)誤"

// @Router /api/v1/tags [post]

func (t Tag) Create(c *gin.Context) {

}

// @Summary 更新標(biāo)簽

// @Tags 標(biāo)簽

// @Produce? json

// @Param id path int true "標(biāo)簽ID"

// @Param name body string false "標(biāo)簽名稱" minlength(3) maxlength(100)

// @Param state body int false "狀態(tài) (0為未刪除、1為已刪除)" Enums(0, 1) default(1)

// @Param modified_by body string true "修改者" minlength(3) maxlength(100)

// @Success 200 {array} model.Tag "成功"

// @Failure 400 {object} errcode.Error "請(qǐng)求錯(cuò)誤"

// @Failure 500 {object} errcode.Error "內(nèi)部錯(cuò)誤"

// @Router /api/v1/tags/{id} [put]

func (t Tag) Update(c *gin.Context) {

}

4.針對(duì)整個(gè)項(xiàng)目進(jìn)行注解，直接在main方法寫(xiě)入如下注解

//@title 項(xiàng)目名稱

//@version 1.0

//@description 這里是描述

func main() {

5.生成執(zhí)行 swag init

這時(shí)會(huì)在我項(xiàng)目的docs文件夾下面生成docs.go、swagger.json、swagger.yaml三個(gè)文件

6.要在routers中進(jìn)行默認(rèn)初始化和注冊(cè)對(duì)應(yīng)的路由：

r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

同時(shí)要引用 _"blog-service/docs" ，不然會(huì)報(bào)錯(cuò)

7.查看接口文檔 ：

8.ok,完成

分享名稱：go語(yǔ)言接口生成文檔 golang 接口文檔
URL鏈接：http://muchs.cn/article8/ddihcop.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供標(biāo)簽優(yōu)化、虛擬主機(jī)、定制開(kāi)發(fā)、定制網(wǎng)站、自適應(yīng)網(wǎng)站、網(wǎng)站建設(shè)

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源： 創(chuàng)新互聯(lián)