codeKK API 列表

这里列出了 codekk.com 主要的 API。
API 总览
开源项目 /op/page/:page获取开源项目列表
/op/detail/:id/readme获取单个开源项目 ReadMe
/op/search搜索开源项目
/op/add-project添加开源项目
/project/not-exist检查开源项目是否已经存在
/op/tagging给项目添加标签
/op/untagging删除项目某个标签
/op/committer/:committer/page/:page根据提交者查询项目列表
源码解析 /opa/page/:page获取源码解析文章列表
/opa/detail/:id获取单个源码解析文章详情
/opa/user/:userName/page/:page根据作者查询源码解析文章列表
职位内推 /job/page/:page获取职位内推文章列表
/job/detail/:id获取单个职位内推文章详情
博客文章 /blog/page/:page获取博客文章列表
/blog/detail/:id获取单个博客文章详情
个人笔记 /notes/user/:userName/page/:page获取个人笔记列表
今日推荐 /recommend/page/:page获取今日推荐列表
/recommend/user/:userName/page/:page根据推荐者查询推荐列表
公共功能 /common/favorite收藏某个内容
/common/unfavorite取消收藏某个内容
/favorite/user/:userName/page/:page某个用户的收藏列表
/common/tagging(未开放)添加标签
/common/untagging(未开放)删除某个标签

以上所有 API:

1. 以 http://api.codekk.com 开头,下面的 Url 只列出 Path 部分

2. 所有返回结果为 JSON 结构,根字段包含 codemessagedata,类似:
{"code":0,"message":"","data":{}}
其中 code 为状态码,0 表示正常,其他表示异常;
message 为提示信息,在 code 不为 0 时为具体异常信息;
data 为具体数据体,结构因具体接口而异,非所有接口必须字段。

一、开源项目相关

1. 获取开源项目列表

Url: /op/page/:page

可选参数:type,取值范围为:array、map、mix,array、map 分别表示返回结果中 data 字段仅包含 projectArray 或 projectDateMap,mix 表示都包含,默认为 array。

HTTP 请求方式:Get

返回:

{"code":0,"message":"获取项目列表成功","data":{"projectArray":[{"id":adf}], "projectDateMap":{"":[{"id":adf}], "":[{"id":adf}]}}}

2. 获取单个开源项目 ReadMe

Url: /op/detail/:id/readme

HTTP 请求方式:Get

返回:

{"code":0,"message":"获取 ReadMe 成功","data":{"id":"57831844fa7a4c321862b43b","content":""}}

3. 搜索开源项目

Url: /op/search

可选参数:text表示搜索内容,page表示页数

HTTP 请求方式:Get

返回:

{"code":0,"message":"","data":{"isFullSearch":false,"projectArray":[{}],"totalCount":3,"pageSize":100}}

4. 添加开源项目

Url: /op/add-project

HTTP 请求方式:Post

返回:

{"code":0,"message":"TODO!"}

5. 检查开源项目是否已经存在

Url: /project/not-exist

HTTP 请求方式:Get

返回:

{"code":0,"message":"TODO!"}

6. 给项目添加标签

Url: /op/tagging

HTTP 请求方式:Post

返回:

{"code":0,"message":"TODO!"}

7. 删除项目某个标签

Url: /op/untagging

HTTP 请求方式:Post

返回:

{"code":0,"message":"TODO!"}

二、源码解析文章、职位内推、博客文章相关

1. 获取解析文章、职位内推、博客文章列表

Url: /opa/page/:page /job/page/:page /blog/page/:page

HTTP 请求方式:Get

返回:

{"code":0,"message":"获取文章列表成功","data":{"summaryArray":[{"id":adf}]}}

2. 获取解析文章、职位内推、博客文章详情

Url: /opa/detail/:id /job/detail/:id /blog/detail/:id

HTTP 请求方式:Get

返回:

{"code":0,"message":"获取文章成功","data":{"_id":"","summaryId":"","content":""}}

三、今日推荐相关

1. 获取今日推荐列表

Url: /recommend/page/:page

HTTP 请求方式:Get

返回:

{"code":0,"message":"获取推荐列表成功","data":{"recommendArray":[{"id":adf}], "recommendDateMap":{"":[{"id":adf}], "":[{"id":adf}]}}}

四、公共功能

1. 收藏、取消收藏功能

Url: /common/favorite /common/unfavorite

HTTP 请求方式:Post

返回:

{"code":0,"message":"收藏成功!"} {"code":0,"message":"取消收藏成功!"}

2. 添加便签、删除标签功能(暂未开放)

Url: /common/tagging /common/untagging

HTTP 请求方式:Post

返回:

{"code":0,"message":"TODO!"} {"code":0,"message":"TODO!"}

Support Me
Apps
About Me
Google+: Trinea trinea
GitHub: Trinea