- Gitea接口
- activitypub
- admin
- List cron tasks
- Run cron task
- List all organizations
- List unadopted repositories
- Adopt unadopted files as a repository
- Delete unadopted files
- Search users according filter conditions
- Create a user
- Delete a user
- Edit an existing user
- Add a public key on behalf of a user
- Delete a user's public key
- Create an organization
- Create a repository on behalf of a user
- miscellaneous
- notification
- List users's notification threads
- Mark notification threads as read, pinned or unread
- Check if unread notifications exist
- Get notification thread by ID
- Mark notification thread as read by ID
- List users's notification threads on a specific repo
- Mark notification threads as read, pinned or unread on a specific repo
- organization
- Create a repository in an organization
- Get list of organizations
- Create an organization
- Get an organization
- Delete an organization
- Edit an organization
- List an organization's webhooks
- Create a hook
- Get a hook
- Delete a hook
- Update a hook
- List an organization's labels
- Create a label for an organization
- Get a single label
- Delete a label
- Update a label
- List an organization's members
- Check if a user is a member of an organization
- Remove a member from an organization
- List an organization's public members
- Check if a user is a public member of an organization
- Publicize a user's membership
- Conceal a user's membership
- List an organization's repos
- Create a repository in an organization
- List an organization's teams
- Create a team
- Search for teams within an organization
- Get a team
- Delete a team
- Edit a team
- List a team's members
- List a particular member of team
- Add a team member
- Remove a team member
- List a team's repos
- List a particular repo of team
- Add a repository to a team
- Remove a repository from a team
- List the current user's organizations
- List a user's organizations
- Get user permissions in organization
- package
- issue
- Search for issues across the repositories that the user has access to
- List a repository's issues
- Create an issue. If using deadline only the date will be taken into account, and time of day ignored.
- List all comments in a repository
- Get a comment
- Delete a comment
- Edit a comment
- Get a list of reactions from a comment of an issue
- Add a reaction to a comment of an issue
- Remove a reaction from a comment of an issue
- Get an issue
- Delete an issue
- Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.
- List all comments on an issue
- Add a comment to an issue
- Delete a comment
- Edit a comment
- Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.
- Get an issue's labels
- Replace an issue's labels
- Add a label to an issue
- Remove all labels from an issue
- Remove a label from an issue
- Get a list reactions of an issue
- Add a reaction to an issue
- Remove a reaction from an issue
- Delete an issue's existing stopwatch.
- Start stopwatch on an issue.
- Stop an issue's existing stopwatch.
- Get users who subscribed on an issue.
- Check if user is subscribed to an issue
- Subscribe user to issue
- Unsubscribe user from issue
- List all comments and events on an issue
- List an issue's tracked times
- Add tracked time to a issue
- Reset a tracked time of an issue
- Delete specific tracked time
- Get all of a repository's labels
- Create a label
- Get a single label
- Delete a label
- Update a label
- Get all of a repository's opened milestones
- Create a milestone
- Get a milestone
- Delete a milestone
- Update a milestone
- repository
- Migrate a remote git repository
- Search for repositories
- Get a repository
- Delete a repository
- Edit a repository's properties. Only fields that are set will be changed.
- Get an archive of a repository
- Return all users that have write access and can be assigned to issues
- List branch protections for a repository
- Create a branch protections for a repository
- Get a specific branch protection for the repository
- Delete a specific branch protection for the repository
- Edit a branch protections for a repository. Only fields that are set will be changed
- List a repository's branches
- Create a branch
- Retrieve a specific branch from a repository, including its effective branch protection
- Delete a specific branch from a repository
- List a repository's collaborators
- Check if a user is a collaborator of a repository
- Add a collaborator to a repository
- Delete a collaborator from a repository
- Get repository permissions for a user
- Get a list of all commits from a repository
- Get a commit's combined status, by branch/tag/commit reference
- Get a commit's statuses, by branch/tag/commit reference
- Gets the metadata of all the entries of the root dir
- Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
- Update a file in a repository
- Create a file in a repository
- Delete a file in a repository
- Apply diff patch to repository
- Get the EditorConfig definitions of a file in a repository
- List a repository's forks
- Fork a repository
- Gets the blob of a repository.
- Get a single commit from a repository
- Get a commit's diff or patch
- Get a note corresponding to a single commit from a repository
- Get specified ref or filtered repository's refs
- Get specified ref or filtered repository's refs
- Gets the tag object of an annotated tag (not lightweight tags)
- Gets the tree of a repository.
- List the hooks in a repository
- Create a hook
- List the Git hooks in a repository
- Get a Git hook
- Delete a Git hook in a repository
- Edit a Git hook in a repository
- Get a hook
- Delete a hook in a repository
- Edit a hook in a repository
- Test a push webhook
- Get available issue templates for a repository
- List a repository's keys
- Add a key to a repository
- Get a repository's key by id
- Delete a key from a repository
- Get languages and number of bytes of code written
- Get a file or it's LFS object from a repository
- Sync a mirrored repository
- List a repo's pull requests
- Create a pull request
- Get a pull request
- Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.
- Get a pull request diff or patch
- Get commits for a pull request
- Check if a pull request has been merged
- Merge a pull request
- Cancel the scheduled auto merge for the given pull request
- create review requests for a pull request
- cancel review requests for a pull request
- List all reviews for a pull request
- Create a review to an pull request
- Get a specific review for a pull request
- Submit a pending review to an pull request
- Delete a specific review from a pull request
- Get a specific review for a pull request
- Dismiss a review for a pull request
- Cancel to dismiss a review for a pull request
- Merge PR's baseBranch into headBranch
- Get all push mirrors of the repository
- add a push mirror to the repository
- Sync all push mirrored repository
- Get push mirror of the repository by remoteName
- deletes a push mirror from a repository by remoteName
- Get a file from a repository
- List a repo's releases
- Create a release
- Get changed files for a pull request
- Get a release by tag name
- Delete a release by tag name
- Get a release
- Delete a release
- Update a release
- List release's attachments
- Create a release attachment
- Get a release attachment
- Delete a release attachment
- Edit a release attachment
- Return all users that can be requested to review in this repo
- Get signing-key.gpg for given repository
- List a repo's stargazers
- Get a commit's statuses
- Create a commit status
- List a repo's watchers
- Check if the current user is watching a repo
- Watch a repo
- Unwatch a repo
- List a repository's tags
- Create a new git tag in a repository
- Get the tag of a repository by tag name
- Delete a repository's tag by name
- List a repository's teams
- Check if a team is assigned to a repository
- Add a team to a repository
- Delete a team from a repository
- List a repo's tracked times
- List a user's tracked times in a repo
- Get list of topics that a repository has
- Replace list of topics for a repository
- Add a topic to a repository
- Delete a topic from a repository
- Transfer a repo ownership
- Accept a repo transfer
- Reject a repo transfer
- Create a wiki page
- Get a wiki page
- Delete a wiki page
- Edit a wiki page
- Get all wiki pages
- Get revisions of a wiki page
- Create a repository using a template
- Get a repository by id
- search topics via keyword
- Create a repository
- settings
- user
- Get the authenticated user
- List the authenticated user's oauth2 applications
- creates a new OAuth2 application
- get an OAuth2 Application
- delete an OAuth2 Application
- update an OAuth2 Application, this includes regenerating the client secret
- List the authenticated user's email addresses
- Add email addresses
- Delete email addresses
- List the authenticated user's followers
- List the users that the authenticated user is following
- Check whether a user is followed by the authenticated user
- Follow a user
- Unfollow a user
- Get a Token to verify
- Verify a GPG key
- List the authenticated user's GPG keys
- Create a GPG key
- Get a GPG key
- Remove a GPG key
- List the authenticated user's public keys
- Create a public key
- Get a public key
- Delete a public key
- List the repos that the authenticated user owns
- Get user settings
- Update user settings
- The repos that the authenticated user has starred
- Whether the authenticated is starring the repo
- Star the given repo
- Unstar the given repo
- Get list of all existing stopwatches
- List repositories watched by the authenticated user
- List all the teams a user belongs to
- List the current user's tracked times
- Search for users
- Get a user
- List the given user's followers
- List the users that the given user is following
- Check if one user is following another user
- List the given user's GPG keys
- Get a user's heatmap
- List the given user's public keys
- List the repos owned by the given user
- The repos that the given user has starred
- List the repositories watched by a user
- List the authenticated user's access tokens
- Create an access token
- delete an access token
- Hat拓展接口
- repository
- actions
- 获取仓库所有文件文件夹GET
- 获取仓库路径下所有文件文件夹GET
- 仓库内搜索文件GET
- 获取单个commit内容GET
- 获取单个commit的dif内容GET
- 创建一个webhookPOST
- 获取一个webhook推送历史GET
- Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_atGET
- 获取所有的发行版GET
- 获取一个发行版GET
- 创建一个发行版POST
- 更新一个发行版PATCH
- 获取所有分支名称GET
- 获取所有分支 (按类型分组)GET
- 获取所有标签名称GET
- 获取所有标签GET
- 获取仓库分支、标签数量GET
- 获取仓库readme文件内容GET
- 获取仓库目录下readme文件内容 GET
- 获取所有commits（按时间分组）GET
- 获取仓库贡献者GET
- 获取仓库commit数量、标签数量、分支数量、发行版数量（按分支）GET
- 获取文件或文件夹下的commit列表GET
- 获取仓库blame内容GET
- 分支、标签、commit的比较接口GET
- 迁移项目（直接）POST
- 获取一个合并请求GET
- 获取合并请求下的commit列表GET
- Get changed files for a pull requestGET
- 仓库下批量更改文件（创建、更新、删除）POST
- 获取合并 请求下所有版本记录GET
- 获取合并请求下一个版本记录的diff内容GET
- 获取仓库代码贡献情况GET
- 获取所有分支GET
- 获取仓库贡献者（包括代码行）GET
- 恢复一个已删除分支POST
- 获取最近的commit列表GET
- 删除一个仓库DELETE
- organization
- users
- admin
- 数据模型
- Schemas
- APIError
- AccessToken represents an API access token.
- AccessToken represents an API access token.
- AddCollaboratorOption
- ActivityPub
- Activity
- AddTimeOption
- AnnotatedTag
- AnnotatedTagObject
- Attachment
- Branch
- BranchProtection
- CombinedStatus
- Comment
- ChangedFile
- Commit contains information generated from a Git commit.
- ChangeFileOperation
- CommitAffectedFiles
- Commit contains information generated from a Git commit.
- ChangeFilesOptions
- CommitDateOptions
- CommitMeta contains meta information of a commit in terms of API.
- CommitStats
- CommitStatus
- CommitStatusState
- CommitUser contains information of a user in the context of a commit.
- ContentsResponse
- CommitMeta contains meta information of a commit in terms of API.
- CreateAccessTokenOption
- CreateBranchProtectionOption
- CreateBranchRepoOption
- CreateEmailOption
- CommitUser contains information of a user in the context of a commit.
- CreateFileOptions
- CreateForkOption
- CreateGPGKeyOption
- CreateHookOption
- CreateHookOptionConfig
- CreateIssueCommentOption
- CreateIssueOption
- CreateKeyOption
- CreateLabelOption
- CreateMilestoneOption
- CreateOAuth2ApplicationOptions
- CreateOrgOption
- CreatePullRequestOption
- CreatePullReviewComment
- CreatePullReviewOptions
- CreateReleaseOption
- CreateRepoOption
- CreateOrUpdateSecretOption
- CreateStatusOption
- CreatePushMirrorOption represents need information to create a push mirror of a repository.
- CreateTagOption
- CreateTeamOption
- CreateUserOption
- CreateWikiPageOptions
- CreatePushMirrorOption represents need information to create a push mirror of a repository.
- Cron
- DeleteEmailOption
- DeleteFileOptions
- DeployKey
- DismissPullReviewOptions
- EditAttachmentOptions
- EditBranchProtectionOption
- OAuth2Application represents an OAuth2 application.
- EditDeadlineOption
- EditGitHookOption
- EditHookOption
- EditIssueCommentOption
- EditIssueOption
- EditLabelOption
- EditMilestoneOption
- EditOrgOption
- EditPullRequestOption
- EditReactionOption
- EditReleaseOption
- EditRepoOption
- EditTeamOption
- EditUserOption
- ExternalTracker
- ExternalWiki
- FileCommitResponse contains information generated from a Git commit for a repo's file.
- Reference represents a Git reference.
- FileDeleteResponse
- FileLinksResponse
- FileResponse
- GPGKey
- GPGKeyEmail
- GeneralAPISettings
- GeneralAttachmentSettings
- FileCommitResponse contains information generated from a Git commit for a repo's file.
- GeneralRepoSettings
- GeneralUISettings
- GenerateRepoOption
- GitBlobResponse
- FilesResponse
- GitEntry
- GitHook
- GitObject represents a Git object.
- GitServiceType
- GitTreeResponse
- Hook
- Identity
- InternalTracker
- Issue
- IssueDeadline
- IssueLabelsOption
- GitObject represents a Git object.
- IssueTemplate
- Label
- IssueFormField
- GitignoreTemplateInfo
- MarkdownOption
- IssueFormFieldType defines issue form field type, can be "markdown", "textarea", "input", "dropdown" or "checkboxes"
- MergePullRequestOption
- MigrateRepoForm
- MigrateRepoOptions
- Milestone
- IssueConfig
- NodeInfo
- IssueConfigContactLink
- NodeInfoServices
- IssueConfigValidation
- NodeInfoSoftware
- NodeInfoUsage
- NodeInfoUsageUsers
- IssueFormFieldType defines issue form field type, can be "markdown", "textarea", "input", "dropdown" or "checkboxes"
- Note
- NotificationCount
- IssueMeta
- NotificationSubject
- NotificationThread
- IssueTemplateLabels
- NotifySubjectType
- OAuth2Application represents an OAuth2 application.
- LabelTemplate
- Organization
- LicenseTemplateInfo
- OrganizationPermissions
- LicensesTemplateListEntry
- PRBranchInfo
- Package
- MarkupOption
- PackageFile
- PayloadCommit
- PayloadCommitVerification
- PayloadUser
- NewIssuePinsAllowed
- Permission
- PublicKey
- PullRequest
- PullRequestMeta
- PullReview
- PullReviewComment
- PullReviewRequestOptions
- Reaction
- Reference represents a Git reference.
- Release
- RepoCollaboratorPermission
- PushMirror
- RepoCommit contains information of a commit in the context of a repository.
- RepoTopicOptions
- RepoTransfer
- Repository
- RepositoryMeta
- ReviewStateType
- SearchResults
- ServerVersion
- StateType
- StopWatch
- SubmitPullReviewOptions
- Tag
- Team
- TimeStamp
- TimelineComment
- TopicName
- TopicResponse
- TrackedTime
- TransferRepoOption
- UpdateFileOptions
- RenameUserOption
- User
- UserHeatmapData
- RepoCommit contains information of a commit in the context of a repository.
- UserSettings
- UserSettingsOptions
- WatchInfo
- WikiCommit
- WikiCommitList
- WikiPage
- WikiPageMetaData
- Secret
- UpdateRepoAvatarOption
- UpdateUserAvatarOption
- Response
- AccessToken
- AccessTokenList
- ActivityFeedsList
- ActivityPub
- AttachmentList
- AnnotatedTag
- Attachment
- BranchList
- Branch
- BranchProtectionList
- BranchProtection
- ChangedFileList
- CommentList
- CombinedStatus
- CommitList
- Comment
- CommitStatusList
- Commit
- ContentsListResponse
- CommitStatus
- CronList
- DeployKeyList
- ContentsResponse
- EmailList
- EmptyRepository
- DeployKey
- GPGKeyList
- FileDeleteResponse
- FileResponse
- FilesResponse
- GPGKey
- GeneralAPISettings
- GeneralAttachmentSettings
- GitHookList
- GeneralRepoSettings
- GeneralUISettings
- GitBlobResponse
- HookList
- GitHook
- GitTreeResponse
- IssueList
- GitignoreTemplateInfo
- IssueTemplates
- GitignoreTemplateList
- Hook
- LabelList
- LanguageStatistics
- Issue
- MarkdownRender
- IssueDeadline
- MilestoneList
- Label
- LabelTemplateInfo
- LabelTemplateList
- NotificationThreadList
- LicenseTemplateInfo
- OAuth2ApplicationList
- LicenseTemplateList
- OrganizationList
- MarkupRender
- Milestone
- PackageFileList
- NodeInfo
- PackageList
- Note
- NotificationCount
- PublicKeyList
- NotificationThread
- PullRequestList
- OAuth2Application
- Organization
- PullReviewCommentList
- PullReviewList
- OrganizationPermissions
- Package
- ReactionList
- ReferenceList
- PushMirrorList
- PublicKey
- ReleaseList
- PullRequest
- PullReview
- RepositoryList
- PullReviewComment
- PushMirror
- StopWatchList
- StringSlice
- Reaction
- TagList
- Reference
- TeamList
- Release
- TimelineList
- TopicListResponse
- RepoCollaboratorPermission
- TopicNames
- RepoIssueConfig
- RepoIssueConfigValidation
- TrackedTimeList
- RepoNewIssuePinsAllowed
- Repository
- UserList
- SearchResults
- Secret
- SecretList
- ServerVersion
- StopWatch
- WikiPageList
- parameterBodies
- string
- Tag
- Team
- TrackedTime
- User
- UserHeatmapData
- UserSettings
- WatchInfo
- WikiCommitList
- WikiPage
- Schemas
获取仓库readme文件内容
开发中
GET
/repos/{owner}/{repo}/readme
请求参数
Authorization
在 Header 添加参数
Authorization
，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password示例：
Authorization: Basic *****************Path 参数
请求示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/repos///readme' \
--header 'Authorization: Basic <encoded-value>'返回响应
🟢200成功
application/json
Body
示例
{
"name": "README.md",
"path": "README.md",
"sha": "1bc8a60ac6ddc876ebc4b60fc68991435bfad93e",
"type": "file",
"size": 9,
"encoding": "base64",
"content": "IyBjZXNoaQoK",
"target": null,
"url": "http://127.0.0.1:10082/api/v1/repos/yystopf/ceshi/contents/README.md?ref=main",
"html_url": "http://127.0.0.1:10082/yystopf/ceshi/src/branch/main/README.md",
"git_url": "http://127.0.0.1:10082/api/v1/repos/yystopf/ceshi/git/blobs/1bc8a60ac6ddc876ebc4b60fc68991435bfad93e",
"download_url": "http://127.0.0.1:10082/yystopf/ceshi/raw/branch/main/README.md",
"submodule_git_url": null,
"_links": {
"self": "http://127.0.0.1:10082/api/v1/repos/yystopf/ceshi/contents/README.md?ref=main",
"git": "http://127.0.0.1:10082/api/v1/repos/yystopf/ceshi/git/blobs/1bc8a60ac6ddc876ebc4b60fc68991435bfad93e",
"html": "http://127.0.0.1:10082/yystopf/ceshi/src/branch/main/README.md"
}
}🟠404记录不存在
修改于 2023-01-18 13:57:46