Homework_lesson5

1.作业要求

每人至少一篇 技术学习报告 或 工具使用方法 或 项目工作经验总结 或 其他值得分享的项目知识。如果你已有博客，请在标题上做连接。

个人大概用了一下下面几个工具，这里稍微介绍一下：

  • umlet工具绘制uml图或者用例图
  • 使用api blueprint编写api文档

    2.umlet工具的使用

  • 安装

ubuntu环境下比较方便直接输入以下命令即可

1
sudo apt intsall umlet

安装完后在控制台上输入umlet就可以打开，可以把它锁定到任务栏方便打开。

windows平台的话去官网下一下安装包顺便配置一下相关的jdk即可。

  • 使用umlet绘图

首先在右上角可以选择绘制的图的类型，比如这里我选择了用例图
pic1
然后就可以看到下方各种相关图形
pic2
双击图形（或者直接拖到左边，箭头只能双击）即可在左边的编辑框内编辑，点击在左边编辑框内的图形，则可以在右下角的方框内编写该图形相关属性，比如我编写了一个名为example的user case并且把它的背景颜色置为红色。

pic3


pic4

编辑完后最后保存即可，umlet会生成一个.uxf文件下次可以打开。

3.使用api blueprint编写api文档

api blueprint可以用来编写http api文档，并且可以使用模拟服务器方便前后端同时开发，这里主要说一下怎么连到github上你加入的组织(连到个人仓库按照官网指示一步步进入就可以了)

  • 关联github账号
    首先去官网按照官网提示一步步将github账号关联上去即可，这边是官网链接
    https://apiary.io/
  • 连接到你加入的组织
    首先要确保你给了该应用权限，在github的setting的application选项里面我们可以看到
    pic5
    进去后你可以看到如下界面则你已经给了apiary足够权限，那么你只要在下面的Organization access给你要连接到的组织选项点击发送一份邮件给组织的owner让他确认后你就可以连接上去了
    pic6
    然后在apiary官网那边你就可以选择到该organization内的repo了。
    pic7
    更多详细的文档可以看官方的这份文档https://help.apiary.io/tools/troubleshooting-github/#connecting-organization-repository
  • 至于编写文档其实就跟写markdown差不多，参考一下文档就可以了，编写完后访问https://xxxx.docs.apiary.io (其中xxxx是你编写文档的时候写的host) 就可以看到一份文档，点击api名称就可以看到详情，选择mock server就可以看到对应的api地址，前后端就可以同时开始开发了。
    pic8