GO 的 Web 开发系列(五)—— 使用 Swagger 生成一份好看的接口文档

经过前面的文章,已经完成了 Web 系统基础功能的搭建,也实现了 API 接口、HTML 模板渲染等功能。接下来要做的就是使用 Swagger 工具,为这些 Api 接口生成一份好看的接口文档。 一、写注释 注释是 Swagger 的灵魂,Swagger 是通过特定格式的注释生成接口文档的。 1.1 基础注释 这部分基础注释对全接口文档通用,指定接口文档的基础信息,可添加在 main 函数上。 注释 说明 示例 title 必填 应用程序的名称。 // @title Swagger Example API version 必填 提供应用程序API的版本。 // @version 1.0 description 应用程序的简短描述。 // @description This is a sample server celler server. tag.name 标签的名称。 // @tag.name This is the name of the tag tag.description 标签的描述。 // @tag.description Cool Description tag.docs.url 标签的外部文档的URL。 // @tag.docs.urlhttps://example.com tag.docs.description 标签的外部文档说明。 // @tag.docs.description Best example documentation termsOfService API的服务条款。 // @termsOfServicehttp://swagger.io/terms/ contact.name 公开的API的联系信息。 // @contact.name API Support contact.url 联系信息的URL。 必须采用网址格式。 // @con...

avatar 玖涯博客 Published on 2024-02-12

git commit emoji 使用指南

master ,这是我的小站,欢迎访问哦~~ git commit emoji 使用指南 ============================ 执行 git commit 时使用 emoji 为本次提交打上一个 “标签”, 使得此次 commit 的主要工作得以凸现,也能够使得其在整个提交历史中易于区分与查找。 commit 格式 git commit 时,提交信息遵循以下格式: :emoji1: :emoji2: 不超过 50 个字的摘要,首字母大写,使用祈使语气,句末不要加句号 提交信息主体 引用相关 issue 或 PR 编号 <#110> 初次提交示例: git commit -m ":tada: Initialize Repo" emoji 指南 emoji emoji 代码 commit 说明 :tada: (庆祝) :tada: 初次提交 :new: (全新) :new: 引入新功能 :bookmark: (书签) :bookmark: 发行/版本标签 :bug: (bug) :bug: 修复 bug :ambulance: (急救车) :ambulance: 重要补丁 :globe_with_meridians: (地球) :globe_with_meridians: 国际化与本地化 :lipstick: (口红) :lipstick: 更新 UI 和样式文件 :clapper: (场记板) :clapper: 更新演示/示例 :rotating_light: (警车灯) :rotating_light: 移除 linter 警告 :wrench: (扳手) :wrench: 修改配置文件 :heavy_plus_sign: (加号) :heavy_plus_sign: 增加一个依赖 :heavy_minus_sign: (减号) :heavy_...

avatar 寻梦城 Published on 2024-02-11

git commit emoji 使用指南

master ,这是我的小站,欢迎访问哦~~ git commit emoji 使用指南 ============================ 执行 git commit 时使用 emoji 为本次提交打上一个 “标签”, 使得此次 commit 的主要工作得以凸现,也能够使得其在整个提交历史中

avatar 寻梦城 Published on 2024-02-11

5️⃣git commit emoji 使用指南

git commit emoji 使用指南

avatar 寻梦城 Published on 2024-02-11

github搜索正确使用方法

master ,这是我的小站,欢迎访问哦~~ github搜索正确使用方法 了解搜索语法 从左至右,依次是 watch star fork,下面分别说下他们的具体作用。 下图是Github中各个功能介绍: <

avatar 寻梦城 Published on 2024-02-09

github搜索正确使用方法

master ,这是我的小站,欢迎访问哦~~ github搜索正确使用方法 了解搜索语法 从左至右,依次是 watch star fork,下面分别说下他们的具体作用。 下图是Github中各个功能介绍: watch watch翻译过来可以称之为观察,点击watch可以看到如下的列表。 star star 翻译过来应该是星星,但是这个翻译没任何具体意义,这里解释为关注或者点赞更合适,当你点击 star,表示你喜欢这个项目或者通俗点,可以把他理解成朋友圈的点赞吧,表示对这个项目的支持。 不过相比朋友圈的点赞,github 里面会有一个列表,专门收集了你所有 start 过的项目,点击 github 个人头像,可以看到 your star的条目,点击就可以查看你 star 过的所有项目了。如下图 fork 当选择 fork,相当于你自己有了一份原项目的拷贝,当然这个拷贝只是针对当时的项目文件,如果后续原项目文件发生改变,你必须通过其他的方式去同步。 一般来说,我们不需要使用 fork 这个功能,除非有一些项目,可能存在 bug 或者可以继续优化的地方,你想帮助原项目作者去完善这个项目或者单纯的想在原来项目基础上己维护一个属于自己项目(比如我 fork 的 AndroidWeekly 客户端,那么你可以 fork 一份项目下来,然后自己对这个项目进行修改完善,当你觉得项目没问题了,你就可以尝试发起 pull request 给原项目作者了。然后就静静等待他的 merge 邮件通知了。 我看到很多人错误的在使用 fork。很多人把 fork 当成了收藏一样的功能,包括一开始使用 github 的我,每次看到一个好的项目就先 fork,因为这样,就可以我的 repository(仓库)列表下查看 fork 的项目了。其实你完全可以使用 star 来达到这个目的。 使用建议 对于一些可...

avatar 寻梦城 Published on 2024-02-09

4️⃣github搜索正确使用方法

github搜索正确使用方法

avatar 寻梦城 Published on 2024-02-09

MBTI

master ,这是我的小站,欢迎访问哦~~ MBTI 起因 我刷抖音,逛bilibili,看到一个视频,讲的是MBTI测试,于是我点开看了看,发现挺有趣的,于是我决定写一篇关于MBTI的文章。 什么是MBTI MBTI全称是Myers-Briggs Type Indicator,中文名是“个人类型分析”。 MBTI测试是一种 personality test,它通过分析一个人的行为、兴趣、价值观等,来确定他们的性格类型。 MBTI测试的结果可以用于了解一个人的性格特点、优势和劣势,以及他们在不同情境下的行为表现。 测试流程 MBTI测试分为四个步骤: 了解自己的性格类型 了解自己的优势和劣势 了解自己的职业方向 了解自己的职业规划 测试结果 MBTI测试的结果可以分为16种不同的类型,每种类型都有特定的性格特点、优势和劣势。 根据测试结果,你可以了解自己的性格类型、优势和劣势,以及如何在不同情境下发挥自己的优势。 我是i人 测试优势 MBTI测试的优势在于它可以帮你了解自己的性格类型、优势和劣势,以及如何在不同情境下发挥自己的优势。 通过MBTI测试,你可以更清楚地了解自己的性格特点,从而更好地调整自己的行为和决策。 同时,MBTI测试还可以帮助你确定自己的职业方向和职业规划,从而更好地规划自己的职业生涯。 测试劣势 MBTI测试的劣势在于它需要花费一定的时间和精力来进行测试。同时,由于测试结果具有一定的主观性,因此需要谨慎对待。 测试建议 在进行MBTI测试之前,建议你先了解自己的性格类型,以及自己的优势和劣势。这样你才能更好地了解自己的特点,并更好地利用MBTI测试的结果。 同时,在进行MBTI测试时,建议你保持客观的态度,不要受到测试结果的影响。这样你才能获得更加客观和真实的测试结果。 最后,在进行MBTI测试时,建议你不要过于注重测试结果,而是要注重测试过程。这样...

avatar 寻梦城 Published on 2024-02-08

MBTI

master ,这是我的小站,欢迎访问哦~~ MBTI 起因 我刷抖音,逛bilibili,看到一个视频,讲的是MBTI测试,于是我点开看了看,发现挺有趣的,于是我决定写一篇关于MBTI的文章。 什么是MBTI MBTI全称是Myers-Briggs Type Indicator,中文名是“个人类型

avatar 寻梦城 Published on 2024-02-08

2️⃣MBTI

我的MBTI

avatar 寻梦城 Published on 2024-02-08
弹