Slate - Api 的文档开发工具

title: Slate - Api 的文档开发工具 id: e0eae8f902820a2ca56a2df0f75a23ce tags: [] date: 2000/01/01 00:00:00 updated: 2023/03/04 19:29:12 isPublic: true --#|[分隔]|#--

Slate - Api 的文档开发工具

大部分公司开发的接口，基本都是提供给本公司同事使用，文档乱一点或者直接使用 swagger 生成，都可以。

但有一些公司的业务是提供服务，需要开发一些公共 Api，供购买服务的第三方公司使用，这时候的 Api，不仅需要实用，还要确保美观、准确、方便。

这时候，这个工具书就可以上场了：Slate: API文档生成器

• 官方示例Demo

• 官方wiki

• 本地使用文档

在本地使用文档中，文档说明，可以直接把项目 clone 下来，安装依赖，使用指令启动或打包项目，同时可以进行修改开发，开发自己的文档，样式、文字等，都可以自定义修改。

安装工具

以下教程直接转子官方使用文档，实际使用步骤可酌情调整

Ubuntu 18.04+

安装 Ruby，NodeJS 和用于编译本机 ruby gem 的工具（已安装的工具跳过）：

sudo apt install ruby ruby-dev build-essential libffi-dev zlib1g-dev liblzma-dev nodejs patch

更新 RubyGems 并安装 bundler：

sudo gem update --system
sudo gem install bundler

macOs

首先，安装 homebrew，然后安装xcode命令行工具：

xcode-select --install

同意Xcode许可：

sudo xcodebuild -license

使用 brew 安装 node

brew install node

更新 RubyGems 并安装 bundler：

sudo gem update --system
sudo gem install bundler

主要使用指令

主要指令如下：

• bundle install：安装项目所需的依赖

• bundle exec middleman server：启动服务

• bundle exec middleman build：打包项目为静态前端文件

大致样式如下，其实开发使用第三方文档时，经常能见到这个样式的开发文档：

Snipaste_2021-01-09_16-05-45.png