如何使用REST API将文件上传到GitHub仓库。

huangapple
go评论96阅读模式
英文:

How to upload a file to a GitHub repos using REST API

问题

Here is the translated code for submitting a file to GitHub and creating a pull request:

Submitting a file to GitHub:

  1. public void storeMessageInGitHub(final Vertx vertx, final String message,
  2.         final String accessToken) {
  4.     // Convert to HTTP Form format as used by GitHub API
  5.     final String messagePath = "/newStuff/randomFilename.json";
  7.     final MultiMap form = MultiMap.caseInsensitiveMultiMap();
  8.     form.set("author", "john.doe@unknown.com");
  9.     form.set("message", "new Comment");
  10.     form.set("branch", "comments-new");
  11.     form.set("path", messagePath); // Use "path" instead of messagePath
  13.     final WebClientOptions options = new WebClientOptions()
  14.             .setUserAgent("CommentService 1.0.4")
  15.             .setSsl(true)
  16.             .setKeepAlive(true);
  18.     final WebClient wc = WebClient.create(vertx, options);
  19.     final String target = "/repos/myuser/myrepo/contents" + messagePath; // Adjust the target URL
  21.     wc.put(443, "api.github.com", target).ssl(true)
  22.             .putHeader("Authorization", "Bearer " + accessToken)
  23.             .sendForm(form)
  24.             .onSuccess(resp -> System.out.printf("Posted to %s%n", messagePath))
  25.             .onFailure(err -> System.err.println(err.getMessage()));
  26. }

Creating a pull request on GitHub:

  1. public void createPullRequest(final Vertx vertx, final String message,
  2.         final String accessToken) {
  4.     // Compose pull request data
  5.     final JsonObject base = new JsonObject()
  6.             .put("ref", "master")
  7.             .put("repo", new JsonObject().put("full_name", "myuser/myrepo"));
  9.     final JsonObject head = new JsonObject()
  10.             .put("ref", "comments-new");
  12.     // Final assembly
  13.     final JsonObject body = new JsonObject();
  14.     body.put("title", "Comment from John Doe");
  15.     body.put("base", base);
  16.     body.put("head", head);
  18.     final WebClientOptions options = new WebClientOptions()
  19.             .setUserAgent("CommentService 1.0.4")
  20.             .setSsl(true)
  21.             .setKeepAlive(true);
  23.     final WebClient wc = WebClient.create(vertx, options);
  25.     final String target = "/repos/myuser/myrepo/pulls";
  27.     wc.post(443, "api.github.com", target).ssl(true)
  28.             .putHeader("Authorization", "Bearer " + accessToken)
  29.             .sendJson(body)
  30.             .onSuccess(res -> System.out.println("Pull request is on its way"))
  31.             .onFailure(err -> System.err.println(err.getMessage()));
  32. }

Please make sure to adjust the target URLs according to GitHub's API documentation, and note that the GitHub API uses a different structure for file uploads and pull request creation compared to Bitbucket.

英文:

I have Java code that submits a file to Bitbucket and creates a pull request. I need to port it to GitHub. In Bitbucket the API takes a form post for a file submission:

  1.     public void storeMessageInBitbucket(final Vertx vertx, final String message,
  2.             final String accessToken) {
  4.         // Convert to HTTP Form format as used by Bitbucket API
  5.         final String messagePath = "/src/newStuff/randomFilename.json";
  7.         final MultiMap form = MultiMap.caseInsensitiveMultiMap();
  8.         form.set("author", "john.doe@unknown.com");
  9.         form.set("message", "new Comment");
  10.         form.set("branch", "comments-new");
  11.         form.set(messagePath, message);
  13.         final WebClientOptions options = new WebClientOptions()
  14.                 .setUserAgent("CommentService 1.0.4")
  15.                 .setSsl(true)
  16.                 .setKeepAlive(true);
  18.         final WebClient wc = WebClient.create(vertx, options);
  19.         final String target = "/2.0/repositories/myuser/myrepo/src";
  20.         wc.post(443, "api.bitbucket.org", target).ssl(true)
  21.                 .putHeader("Content-Type", "application/x-www-form-urlencoded")
  22.                 .putHeader("Authorization", "Bearer " + accessToken)
  23.                 .sendForm(form)
  24.                 .onSuccess(resp -> System.out.printf("Posted to %s%n", messagePath))
  25.                 .onFailure(err -> System.err.println(err.getMessage()));
  27.     }

Similar the submission of a PR:

  1.     public void createPullRequest(final Vertx vertx, final String message,
  2.             final String accessToken) {
  4.         // Compose pull request data
  5.         final JsonObject source = new JsonObject()
  6.                 .put("branch", new JsonObject().put("name", "comments-new"))
  7.                 .put("repository", new JsonObject().put("full_name", "myuser/myrepo"));
  9.         final JsonObject destination = new JsonObject()
  10.                 .put("branch", new JsonObject().put("name", "master"));
  12.         // Final assembly
  13.         final JsonObject body = new JsonObject();
  14.         body.put("title", "Comment from John Doe");
  15.         body.put("source", source);
  16.         body.put("destination", destination);
  17.         body.put("close_source_branch", true);
  19.         final WebClientOptions options = new WebClientOptions()
  20.                 .setUserAgent("CommentService 1.0.4")
  21.                 .setSsl(true)
  22.                 .setKeepAlive(true);
  24.         final WebClient wc = WebClient.create(vertx, options);
  26.         final String target = "/2.0/repositories/myuser/myrepo/pullrequests/";
  28.         wc.post(443, "api.bitbucket.org", target).ssl(true)
  29.                 .putHeader("Content-Type", "application/json")
  30.                 .putHeader("Authorization", "Bearer " + accessToken)
  31.                 .sendJson(body)
  32.                 .onSuccess(res -> System.out.println("Pull request is on its way"))
  33.                 .onFailure(err -> System.err.println(err.getMessage()));
  34.     }

I looked at the github CLI and the GitHub REST API which does address creating a pull request, but I couldn't find how to upload a file.

Where could I find the matching documentation and/or a sample?s

答案1

得分: 1

上传文件到代码库，请参阅 https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#create-or-update-file-contents

英文:

To upload a file to a repository see https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#create-or-update-file-contents

huangapple
  • 本文由 发表于 2023年6月26日 16:11:48
  • 转载请务必保留本文链接：https://go.coder-hub.com/76554762.html
  • github
  • github-api
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定