文档站点

dapeng-/soa框架体系中的一个重要特性。通过文档中心不仅可以了解到所开发的服务的详细信息，例如服务的版本、接口、结构体等详细信息，而且通过文档中心中的在线测试模块，还可以简化开发人员在服务开发过程中的测试调试过程，提高了开发人员的开发效率。

• 文档中心的启动

  在实现完服务的service接口并配置SpringBean之后，使用sbt-dapeng插件 runContainer 指令启动服务。在服务启动之后，dapeng内嵌的文档中心也一并被启动。我们只需要在本地通过浏览器访问相应的端口。即可进入到文档中，例如localhost:8192。dapeng默认的文档中心的端口是8192，同时我们也可以在dapeng.properties文件中，通过修改soa.apidoc.port的值来自定义端口。文档中心启动后的页面如下图所示：

• 文档中心API界面

点击启动页面中的Learn more或者API按钮，即可进入文档中心的API界面，如下图所示：

  在API界面中，列举了该应用包含的所有服务（在本示例中只有一个HelloService服务），并对相应的服务给出了简要信息，包括服务的版本号、所属的group以及服务所用到的方法数量、枚举和结构体数量等。通过API界面，开发人员可以对服务有一个基本的了解。如果该应用包含的服务过多，我们可以通过右上角的搜索框进行搜索，假使开发人员对服务足够了解，也可以用其来搜索服务中的方法、结构体和枚举等服务详细信息。

• 服务详情文档

在文档中心的API界面中点击服务名，即可进入相应的服务详情文档界面，如下图所示：

  服务详情文档是对API界面中服务简要信息的一种补充说明。在该界面中可以看到服务中详细的方法列表、结构体列表、枚举结构列表以及服务的事件清单和说明。如果想要对这些信息进行详细的了解，可以点击相应的名称。
  点击方法名称或者其简述，可以了解到与该方法相关的业务描述、接口依赖、边界异常说明、输入与输出、前置检查、逻辑处理以相关的数据库变更等详细信息。
  点击结构体或者枚举名称，则会给出结构体或枚举中字段的详细信息（字段类型、是否必填以及相应的功能描述）。
  在每个方法的右侧有个测试按钮，点击按钮即可进入在线测试界面，对相应的方法进行功能测试。在下一节将会对在在线测试进行详细的描述说明。

---