{"action":"created","comment":{"url":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls/comments/173357031","pull_request_review_id":102535426,"id":173357031,"diff_hunk":"@@ -0,0 +1,91 @@\n+---\n+order: 19\n+title:\n+  en-US: API Development\n+  zh-CN: 使用 API 文档工具\n+type: 进阶\n+---\n+\n+In daily development, we usually sperate frontend development from backend development based on a API standard, so that the two teams won't block each other to ensure progress of project.\n+\n+In Ant Design Pro we already have a relatively complete set of mock feature, and [roadhog-api-doc](https://github.com/nikogu/roadhog-api-doc) is a tool that can generate API documentation from your mock data to give you a clear overview of your APIs.\n+\n+Live Demo：[Pro API Docs](https://preview.pro.ant.design/api.html)。\n+\n+## How to use\n+\n+```bash\n+$ npm install roadhog-api-doc -g\n+```\n+\n+### Run locally\n+\n+In the project root directory:\n+\n+```bash\n+$ roadhog-api-doc start [port]\n+```\n+\n+Then a document website will launch for the current project, provided that it must be a project based on [roadhog](https://github.com/sorrycc/roadhog) as with Ant Design Pro and that the data mock feature be used because the the source of documentation is the mock file.\n+\n+It should be additionally noted that the above `port` parameter refers to the current local `roadhog` application. If specified, you can directly access the project's API locally. If not specified, the network request will be staticized.\n+\n+### Genrate static site\n+\n+```bash\n+$ roadhog-api-doc build\n+```\n+\n+This command will generate three files: `api.html`, `api.js`, `api.css`. You can deploy these files to your own site for online access, where the data is already statically converted (translating network requests into hardcode data).\n+\n+### Writing Documentation","path":"docs/api-doc.en-US.md","position":41,"original_position":41,"commit_id":"f8d06498455bc22df129ae8d9f4cfd2f81bc4d2c","original_commit_id":"f8d06498455bc22df129ae8d9f4cfd2f81bc4d2c","user":{"login":"ddcat1115","id":7017767,"avatar_url":"https://avatars1.githubusercontent.com/u/7017767?v=4","gravatar_id":"","url":"https://api.github.com/users/ddcat1115","html_url":"https://github.com/ddcat1115","followers_url":"https://api.github.com/users/ddcat1115/followers","following_url":"https://api.github.com/users/ddcat1115/following{/other_user}","gists_url":"https://api.github.com/users/ddcat1115/gists{/gist_id}","starred_url":"https://api.github.com/users/ddcat1115/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ddcat1115/subscriptions","organizations_url":"https://api.github.com/users/ddcat1115/orgs","repos_url":"https://api.github.com/users/ddcat1115/repos","events_url":"https://api.github.com/users/ddcat1115/events{/privacy}","received_events_url":"https://api.github.com/users/ddcat1115/received_events","type":"User","site_admin":false},"body":"这里时态和上面几个title保持一致吧","created_at":"2018-03-09T03:20:40Z","updated_at":"2018-03-09T03:20:40Z","html_url":"https://github.com/ant-design/ant-design-pro-site/pull/149#discussion_r173357031","pull_request_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls/149","author_association":"COLLABORATOR","_links":{"self":{"href":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls/comments/173357031"},"html":{"href":"https://github.com/ant-design/ant-design-pro-site/pull/149#discussion_r173357031"},"pull_request":{"href":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls/149"}}},"pull_request":{"url":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls/149","id":165508861,"html_url":"https://github.com/ant-design/ant-design-pro-site/pull/149","diff_url":"https://github.com/ant-design/ant-design-pro-site/pull/149.diff","patch_url":"https://github.com/ant-design/ant-design-pro-site/pull/149.patch","issue_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/issues/149","number":149,"state":"open","locked":false,"title":"Translate api doc","user":{"login":"yesmeck","id":465125,"avatar_url":"https://avatars0.githubusercontent.com/u/465125?v=4","gravatar_id":"","url":"https://api.github.com/users/yesmeck","html_url":"https://github.com/yesmeck","followers_url":"https://api.github.com/users/yesmeck/followers","following_url":"https://api.github.com/users/yesmeck/following{/other_user}","gists_url":"https://api.github.com/users/yesmeck/gists{/gist_id}","starred_url":"https://api.github.com/users/yesmeck/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/yesmeck/subscriptions","organizations_url":"https://api.github.com/users/yesmeck/orgs","repos_url":"https://api.github.com/users/yesmeck/repos","events_url":"https://api.github.com/users/yesmeck/events{/privacy}","received_events_url":"https://api.github.com/users/yesmeck/received_events","type":"User","site_admin":false},"body":"","created_at":"2018-01-27T08:17:17Z","updated_at":"2018-03-09T03:20:40Z","closed_at":null,"merged_at":null,"merge_commit_sha":"911226740dcdf5bed19d164bafada71327be7261","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls/149/commits","review_comments_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls/149/comments","review_comment_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls/comments{/number}","comments_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/issues/149/comments","statuses_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/statuses/f8d06498455bc22df129ae8d9f4cfd2f81bc4d2c","head":{"label":"ant-design:translate-api-doc","ref":"translate-api-doc","sha":"f8d06498455bc22df129ae8d9f4cfd2f81bc4d2c","user":{"login":"ant-design","id":12101536,"avatar_url":"https://avatars3.githubusercontent.com/u/12101536?v=4","gravatar_id":"","url":"https://api.github.com/users/ant-design","html_url":"https://github.com/ant-design","followers_url":"https://api.github.com/users/ant-design/followers","following_url":"https://api.github.com/users/ant-design/following{/other_user}","gists_url":"https://api.github.com/users/ant-design/gists{/gist_id}","starred_url":"https://api.github.com/users/ant-design/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ant-design/subscriptions","organizations_url":"https://api.github.com/users/ant-design/orgs","repos_url":"https://api.github.com/users/ant-design/repos","events_url":"https://api.github.com/users/ant-design/events{/privacy}","received_events_url":"https://api.github.com/users/ant-design/received_events","type":"Organization","site_admin":false},"repo":{"id":94879020,"name":"ant-design-pro-site","full_name":"ant-design/ant-design-pro-site","owner":{"login":"ant-design","id":12101536,"avatar_url":"https://avatars3.githubusercontent.com/u/12101536?v=4","gravatar_id":"","url":"https://api.github.com/users/ant-design","html_url":"https://github.com/ant-design","followers_url":"https://api.github.com/users/ant-design/followers","following_url":"https://api.github.com/users/ant-design/following{/other_user}","gists_url":"https://api.github.com/users/ant-design/gists{/gist_id}","starred_url":"https://api.github.com/users/ant-design/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ant-design/subscriptions","organizations_url":"https://api.github.com/users/ant-design/orgs","repos_url":"https://api.github.com/users/ant-design/repos","events_url":"https://api.github.com/users/ant-design/events{/privacy}","received_events_url":"https://api.github.com/users/ant-design/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/ant-design/ant-design-pro-site","description":null,"fork":false,"url":"https://api.github.com/repos/ant-design/ant-design-pro-site","forks_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/forks","keys_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/teams","hooks_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/hooks","issue_events_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/issues/events{/number}","events_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/events","assignees_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/assignees{/user}","branches_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/branches{/branch}","tags_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/tags","blobs_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/git/refs{/sha}","trees_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/statuses/{sha}","languages_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/languages","stargazers_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/stargazers","contributors_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/contributors","subscribers_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/subscribers","subscription_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/subscription","commits_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/commits{/sha}","git_commits_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/git/commits{/sha}","comments_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/comments{/number}","issue_comment_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/issues/comments{/number}","contents_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/contents/{+path}","compare_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/merges","archive_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/downloads","issues_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/issues{/number}","pulls_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls{/number}","milestones_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/milestones{/number}","notifications_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/labels{/name}","releases_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/releases{/id}","deployments_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/deployments","created_at":"2017-06-20T10:23:56Z","updated_at":"2018-03-08T14:55:55Z","pushed_at":"2018-03-08T05:26:55Z","git_url":"git://github.com/ant-design/ant-design-pro-site.git","ssh_url":"git@github.com:ant-design/ant-design-pro-site.git","clone_url":"https://github.com/ant-design/ant-design-pro-site.git","svn_url":"https://github.com/ant-design/ant-design-pro-site","homepage":"http://pro.ant.design/","size":6888,"stargazers_count":77,"watchers_count":77,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":107,"mirror_url":null,"archived":false,"open_issues_count":18,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit"},"forks":107,"open_issues":18,"watchers":77,"default_branch":"master"}},"base":{"label":"ant-design:master","ref":"master","sha":"8da35d87d0459c33abbf479cb9f8236d5731e0d3","user":{"login":"ant-design","id":12101536,"avatar_url":"https://avatars3.githubusercontent.com/u/12101536?v=4","gravatar_id":"","url":"https://api.github.com/users/ant-design","html_url":"https://github.com/ant-design","followers_url":"https://api.github.com/users/ant-design/followers","following_url":"https://api.github.com/users/ant-design/following{/other_user}","gists_url":"https://api.github.com/users/ant-design/gists{/gist_id}","starred_url":"https://api.github.com/users/ant-design/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ant-design/subscriptions","organizations_url":"https://api.github.com/users/ant-design/orgs","repos_url":"https://api.github.com/users/ant-design/repos","events_url":"https://api.github.com/users/ant-design/events{/privacy}","received_events_url":"https://api.github.com/users/ant-design/received_events","type":"Organization","site_admin":false},"repo":{"id":94879020,"name":"ant-design-pro-site","full_name":"ant-design/ant-design-pro-site","owner":{"login":"ant-design","id":12101536,"avatar_url":"https://avatars3.githubusercontent.com/u/12101536?v=4","gravatar_id":"","url":"https://api.github.com/users/ant-design","html_url":"https://github.com/ant-design","followers_url":"https://api.github.com/users/ant-design/followers","following_url":"https://api.github.com/users/ant-design/following{/other_user}","gists_url":"https://api.github.com/users/ant-design/gists{/gist_id}","starred_url":"https://api.github.com/users/ant-design/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ant-design/subscriptions","organizations_url":"https://api.github.com/users/ant-design/orgs","repos_url":"https://api.github.com/users/ant-design/repos","events_url":"https://api.github.com/users/ant-design/events{/privacy}","received_events_url":"https://api.github.com/users/ant-design/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/ant-design/ant-design-pro-site","description":null,"fork":false,"url":"https://api.github.com/repos/ant-design/ant-design-pro-site","forks_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/forks","keys_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/teams","hooks_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/hooks","issue_events_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/issues/events{/number}","events_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/events","assignees_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/assignees{/user}","branches_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/branches{/branch}","tags_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/tags","blobs_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/git/refs{/sha}","trees_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/statuses/{sha}","languages_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/languages","stargazers_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/stargazers","contributors_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/contributors","subscribers_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/subscribers","subscription_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/subscription","commits_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/commits{/sha}","git_commits_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/git/commits{/sha}","comments_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/comments{/number}","issue_comment_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/issues/comments{/number}","contents_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/contents/{+path}","compare_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/merges","archive_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/downloads","issues_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/issues{/number}","pulls_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls{/number}","milestones_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/milestones{/number}","notifications_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/labels{/name}","releases_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/releases{/id}","deployments_url":"https://api.github.com/repos/ant-design/ant-design-pro-site/deployments","created_at":"2017-06-20T10:23:56Z","updated_at":"2018-03-08T14:55:55Z","pushed_at":"2018-03-08T05:26:55Z","git_url":"git://github.com/ant-design/ant-design-pro-site.git","ssh_url":"git@github.com:ant-design/ant-design-pro-site.git","clone_url":"https://github.com/ant-design/ant-design-pro-site.git","svn_url":"https://github.com/ant-design/ant-design-pro-site","homepage":"http://pro.ant.design/","size":6888,"stargazers_count":77,"watchers_count":77,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":107,"mirror_url":null,"archived":false,"open_issues_count":18,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit"},"forks":107,"open_issues":18,"watchers":77,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls/149"},"html":{"href":"https://github.com/ant-design/ant-design-pro-site/pull/149"},"issue":{"href":"https://api.github.com/repos/ant-design/ant-design-pro-site/issues/149"},"comments":{"href":"https://api.github.com/repos/ant-design/ant-design-pro-site/issues/149/comments"},"review_comments":{"href":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls/149/comments"},"review_comment":{"href":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/ant-design/ant-design-pro-site/pulls/149/commits"},"statuses":{"href":"https://api.github.com/repos/ant-design/ant-design-pro-site/statuses/f8d06498455bc22df129ae8d9f4cfd2f81bc4d2c"}},"author_association":"OWNER"}}
{"actor":{"display_login":"ddcat1115"}}