获取项目README文件

开发环境

http://dev-cn.your-api-server.com

GET

/api/{owner}/{repo}/readme.json

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

Query 参数

filepath

string

可选

子目录名称，默认为空

ref

string

可选

分支名称、标签名称或是提交记录id，默认为默认分支

Cookie 参数

autologin_trustie

string

可选

默认值:

3acc38c27d61a347f5c16fbca2c4964b181a2f79

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'http://dev-cn.your-api-server.com/api///readme.json' \
--header 'Cookie: autologin_trustie=3acc38c27d61a347f5c16fbca2c4964b181a2f79'

返回响应

🟢200成功

application/json

Body

type

string

类型

必需

encoding

string

文件加密方式

必需

size

integer

文件大小

必需

name

string

文件名称

必需

path

string

文件路径

必需

content

string

文件内容

必需

sha

string

文件标识

必需

replace_content

string

替换后的文件内容

必需

示例

{
    "type": "file",
    "encoding": "base64",
    "size": 13,
    "name": "README.md",
    "path": "README.md",
    "content": "# ceshi_doc\n\n",
    "sha": "91d1da709ed2610e8bcd7b2f6c988f4b8888e515",
    "replace_content": "# ceshi_doc\n\n"
}

修改于 2025-02-07 02:44:09

获取项目代码子目录或者文件

获取文件树列表