Git-Blobs - GitHub-Dokumentation

Git-Blobs

Verwende die REST-API, um mit einem Git-Blob (Binary Large Object) zu interagieren. Git-Blob ist der Objekttyp, der zum Speichern des Inhalts jeder Datei in einem Repository verwendet wird.

Informationen zu Git-Blobs

Ein Git-Blob (Binary Large Object) ist der Objekttyp, der zum Speichern des Inhalts jeder Datei in einem Repository verwendet wird. Der SHA-1-Hash der Datei wird berechnet und im Blobobjekt gespeichert. Diese Endpunkte ermöglichen dir das Lesen und Schreiben von Blobobjekten in deine Git-Datenbank auf GitHub. Blobs nutzen diese benutzerdefinierten Medientypen. Weitere Informationen zur Verwendung von Medientypen in der API findest du hier.

Benutzerdefinierte Medientypen für Blobs

Dies sind die unterstützten Medientypen für Blobs.

application/json
application/vnd.github.raw

Weitere Informationen findest du unter Medientypen.

Create a blob

Funktioniert mit GitHub Apps

Parameter

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
Body parameters
Name, Type, Description
`content`stringRequired The new blob's content.
`encoding`string The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. Default: `utf-8`

HTTP-Antwortstatuscodes

Statuscode	BESCHREIBUNG
`201`	Created
`403`	Forbidden
`404`	Resource not found
`409`	Conflict
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele

post/repos/{owner}/{repo}/git/blobs

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/git/blobs \
  -d '{"content":"Content of the blob","encoding":"utf-8"}'

Response

Status: 201

{
  "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
  "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15"
}

Get a blob

Funktioniert mit GitHub Apps

The content in the response will always be Base64 encoded.

Note: This API supports blobs up to 100 megabytes in size.

Parameter

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`file_sha`stringRequired

HTTP-Antwortstatuscodes

Statuscode	BESCHREIBUNG
`200`	OK
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele

get/repos/{owner}/{repo}/git/blobs/{file_sha}

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/git/blobs/FILE_SHA

Response

Status: 200

{
  "content": "Q29udGVudCBvZiB0aGUgYmxvYg==",
  "encoding": "base64",
  "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
  "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
  "size": 19,
  "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg=="
}