{"id":24089450,"url":"https://github.com/longbridge/whale-api-docs","last_synced_at":"2025-07-23T00:06:16.069Z","repository":{"id":196424109,"uuid":"694081792","full_name":"longbridge/whale-api-docs","owner":"longbridge","description":"Longbridge Whale API Docs","archived":false,"fork":false,"pushed_at":"2023-12-04T12:05:14.000Z","size":556,"stargazers_count":1,"open_issues_count":1,"forks_count":4,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-01-10T04:13:09.869Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/longbridge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-20T09:45:20.000Z","updated_at":"2023-10-31T01:47:03.000Z","dependencies_parsed_at":"2024-12-10T00:36:42.554Z","dependency_job_id":null,"html_url":"https://github.com/longbridge/whale-api-docs","commit_stats":null,"previous_names":["longbridgeapp/whale-api-docs","longbridge/whale-api-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longbridge%2Fwhale-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longbridge%2Fwhale-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longbridge%2Fwhale-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longbridge%2Fwhale-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/longbridge","download_url":"https://codeload.github.com/longbridge/whale-api-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240983030,"owners_count":19888607,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-10T04:13:19.143Z","updated_at":"2025-02-27T05:25:40.339Z","avatar_url":"https://github.com/longbridge.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"LongPort OpenAPI Documentation\n\nhttps://open.longportapp.com\n\n## CONTRIBUTING\n\n请阅读 [CONTRIBUTING.md](./CONTRIBUTING.md) 文档。\n\nPlease following the [CONTRIBUTING.md](./CONTRIBUTING.md) document.\n\n## Getting started \n\n```shell\n$ cd whale-api-docs \u0026\u0026 yarn\n$ yarn dev:swagger\n# 新一个终端 Tab\n$ yarn dev:zh-HK  #繁体版本\n$ yarn dev:en  # EN 版本\n```\n\n浏览器输入 [localhost:8000/en](http://localhost:8000/en) 或者 [localhost:8000/zh-HK](http://localhost:8000/zh-HK)\n\n#### Canary \u0026 Prod 地址找李波\n\n## Style Guide\n\n### 文档需要遵守以下规范：\n\n- 遵循中英文书写规范，中英文加空格间隔，正确使用标点符号，正确用词，精确专业术语用词、大小写。\n- Longbridge 员工请阅读内部：[文案书写指导](https://longbridge.feishu.cn/wiki/wikcnqOEWHe43bdSLMP0S42vvvg) 与 [Open API 接口规范](https://longbridge.feishu.cn/wiki/wikcnb0RtZ8OEuAodGBXaOL6Nxh)。\n- Markdown 文档需要提供规范的 Meta 信息。\n\n### Markdown Meta 信息格式\n\n\u003e 只针对非 Swagger 生成的 Markdown 文档\n\n在每个 `.md` 文件的开头添加内容（示例）：\n\n```yml\n---\ntitle: '开放平台文档标题'\nid: $category_$file_name # category 指文檔分類 file_name 指文档的文件名以中横线分隔的字符串\nslug: '/xxx' # 注意前面必须加上 /，例如 /trade-order-create 这样的 slug 保持和 id 一致\nsidebar_position: 1 // 显示的顺序，数字越小越靠前\n---\n```\n\n#### Markdown 文档分类\n\n\u003e 只针对非 Swagger 生成的 Markdown 文档\n\n为了将文档进行分类需要在 docs 中每个子目录添加 _category_.json 配置文件，文件内容如下：\n\n```json5\n{\n  position: 1, // 显示的顺序，数字越小越靠前\n  label: 'OpenAPI 介绍', // 文档分类名称，显示在左边栏\n  link: null,\n}\n```\n\n#### 特别提示\n\nMarkdown 涉及到的静态资源例如：图片、视频等都需要上传到 CDN 再引用，不要放到项目中引用。\n\n不推荐的写法（这样定义会导致加载资源失败的情况）\n\n```md\n![流程图片](../../static/xxxx.png)\n```\n\n推荐的写法（从后台上传到 CDN 拿到 CDN 地址，然后在 Markdown 中引用）\n\n```md\n![流程图片](https://pub.lbkrs.com/xxx/xxx.png)\n```\n\n\u003e Before commit you should be run `autocorrect --fix .` first\n\u003e [How to use autocorrect](https://github.com/huacnlee/autocorrect)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flongbridge%2Fwhale-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flongbridge%2Fwhale-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flongbridge%2Fwhale-api-docs/lists"}