个人博客
详细搭建流程见:github提交hexo自动更新的博客设计
swagger editor
无论是前端还是后端开发,都或多或少地被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力,经常来不及更新。其实无论是前端调用后端,还是后端调用后端,都期望有一个好的接口文档。但是这个接口文档对于程序员来说,就跟注释一样,经常会抱怨别人写的代码没有写注释,然而自己写起代码起来,最讨厌的,也是写注释。所以仅仅只通过强制来规范大家是不够的,随着时间推移,版本迭代,接口文档往往很容易就跟不上代码了。
发现了痛点就要去找解决方案。解决方案用的人多了,就成了标准的规范,这就是Swagger的由来。
作为Java届服务端的大一统框架Spring,迅速将Swagger规范纳入自身的标准,建立了Spring-swagger项目,后面改成了现在的Springfox。通过在项目中引入Springfox,可以扫描相关的代码,生成该描述文件,进而生成与代码一致的接口文档和客户端代码。这种通过代码生成接口文档的形式,在后面需求持续迭代的项目中,显得尤为重要和高效。
通过http://editor.swagger.io/,就可以在线查看api文档了。
可是问题在于,这个服务器在国外,国内访问的速度简直感人,所以,这时候,我选择自己部署一个,幸好swagger官方,也提供了简便的部署方式:docker
1 | docker pull swaggerapi/swagger-editor |
sourcegraph
开源代码库向来都是程序员们的金矿,但是如何从中选择出合适的代码并且学会使用它们可是非常需要技巧的。GitHub作为一款基于Git的代码管理工具和协同工具是很优秀的,然而作为代码浏览和搜索工具,就和IDE差的很远了。
Sourcegraph是一款可以为 Github 上的代码添加了即时文档和类型提示,并为每一个标识符添加了跳转到定义处的链接的Chrome 扩展,它允许你像使用一个很好的IDE 那样浏览源代码。
当然了,它可以作为chrome插件来使用,不过那样的速度还是会受到国外网络的限制,因此,也可以部署一个到本地:
1 | docker pull sourcegraph/server:3.13.1 |