Talk about how Laravel integrates GitHub to store files

                                                                                                                                                                                

The following tutorial column will introduce to you how Laravel integrates GitHub to store files. I hope it will be helpful to you!

GitHub API introduction

Interface documentation: docs.github.com/en/restWhat you need to use is A very powerful GitHub API, where you only need to create or update the file content interface.

Create or update file content

Request address: api.github.com/repos/{owner}/ {repo}/contents/{path}

• Request method:

  PUT
##Parameters

##Name

TypePositionacceptstringapplication/vnd.github. v3 jsonstringpathstringpath ##pathpathmessagebodycontentbodyBase64bodybranchbodycommitterbodyauthorbodycommitter

Description
headerIt is recommended to set it to			##owner
username		repo
Warehouse name			string
File storage path			string
Required - The commit message			string
Required - New file content, encoded using			shastring
Required if the file is to be updated - blob of the file being replaced SHA			string
Branch name - The default branch of the repository is usually master			object
Committer - Default Author of the file for the authenticated user			object
- Defaults to committer, if	is omitted, it is the authenticated user		committer Attributes of the object

Name

Description

(string)Required - The name of the author or submitter of the submission. If name is omitted you will receive email is omitted, you will receive 422Name

##name
422 status code	##email (string)Required - Email of the submission's author or submitter. If
status code	date (string)
author Properties of the object

Description

nameRequired - The author or submitter of the submission name. If name is omitted you will receive 422 is omitted, you will receive 422 status code

Authentication

The official provides three methods:

• Basic authentication - username and password

• OAuth2 Token - token

• OAuth2 key/secret - client_id and client_secret (only supports query)

Recommended Method 2.

Setting token

Settings > Developer settings > Personal access tokens > Generate new token

The generated token should be saved and only displayed once.

Create a warehouse

Be sure to set the warehouse to be public so that it can be accelerated using jsDelivr CDN.

The problem with using GitHub warehouse as a picture bed is that access to GitHub in China is very slow. You can use jsDelivr CDN to speed up access. jsDelivr is a free and open source CDN solution. The platform is the first free CDN service to connect mainland China and overseas. It has an ICP license issued by the Chinese government, so there is no need to worry about the use of the Great Firewall of China. To use jsDelivr to accelerate access, you need to set the custom domain name to https://cdn.jsdelivr.net/gh/username/image bed warehouse name.

Laravel code

needs to set several configuration parameters, it is recommended to put them in the .env file.

GITHUB_FILE_REPOSITORY=YOUR_REPOSITORY
GITHUB_FILE_BRANCH=master
GITHUB_FILE_TOKEN=YOUR_TOKEN
GITHUB_FILE_PATH=YOUR_PATH
GITHUB_FILE_NAME=1
GITHUB_FILE_COMMIT_MESSAGE="YOUR COMMIT MESSAGE"

Then create a configuration file under config, I created a github-file.php configuration file

<?php
return [
 /**
 * GitHub 仓库
 */
 &#39;repository&#39; => env(&#39;GITHUB_FILE_REPOSITORY&#39;, &#39;&#39;),

 /**
 * 分支
 */
 &#39;branch&#39; => env(&#39;GITHUB_FILE_BRANCH&#39;, &#39;master&#39;),

 /**
 * Personal access token
 */
 &#39;token&#39; => env(&#39;GITHUB_FILE_TOKEN&#39;, &#39;&#39;),

 /**
 * 存储路径，若 GitHub 仓库中没有，则自动创建
 */
 &#39;path&#39; => env(&#39;GITHUB_FILE_PATH&#39;, &#39;&#39;),

 /**
 * 自定义域名
 * 若不定义则使用 https://raw.githubusercontent.com/ 出于某些原因可能图片加载会很慢，甚至失败
 * 建议使用 https://cdn.jsdelivr.net/gh/ 加速
 */
 &#39;domain&#39; => env(&#39;GITHUB_FILE_DOMAIN&#39;, &#39;https://cdn.jsdelivr.net/gh/&#39;),

 /**
 * 文件命名
 * 1 - 以时间戳方式重命名
 * 2 - 以随机字符串方式重命名
 * 3 - 保持原名
 * ......
 */
 &#39;name&#39; => env(&#39;GITHUB_FILE_NAME&#39;, 1),

 /**
 * commit 记录
 */
 &#39;commit_message&#39; => env(&#39;GITHUB_FILE_COMMIT_MESSAGE&#39;, &#39;&#39;),];

Create a Trait Reuse the upload function

<?php
namespace App\Traits;use Exception;use Illuminate\Support\Str;
use Illuminate\Support\Facades\Http;
trait UploadToGithub{
    public function uploadToGithub($file, $message = &#39;&#39;)
    {
        $path = config(&#39;github-file.path&#39;) . &#39;/&#39; . $this->setFileName($file);
        $repository = config(&#39;github-file.repository&#39;);

        if ($file->isValid()) {
            $url = "https://api.github.com/repos/$repository/contents/$path";

            $response = Http::withToken(config(&#39;github-file.token&#39;))->put($url, [
                &#39;message&#39; => $message ?: config(&#39;github-file.commit_message&#39;),
                &#39;content&#39; => base64_encode(file_get_contents($file))
            ]);

            // 上传失败抛出一个错误，成功则返回 JSON
            $body = $response->throw()->json();

            // 上传成功后 GitHub API 返回的是 201，其实有了上一步这里的判断可以省略
            if ($response->successful()) {
                return config(&#39;github-file.domain&#39;)
                    ? rtrim(config(&#39;github-file.domain&#39;), &#39;/&#39;) . &#39;/&#39; . trim($repository, &#39;/&#39;) . &#39;/&#39; . ltrim($body[&#39;content&#39;][&#39;path&#39;], &#39;/&#39;)
                    : $body[&#39;content&#39;][&#39;download_url&#39;];
            }
        }

        throw new Exception(&#39;未发现图片&#39;);
    }

    /**
     * 生成图片名称
     * @param $file
     * @return mixed|string
     */
    private function setFileName($file)
    {
        switch (config(&#39;github-file.name&#39;)) {
            case 1:
                return date(&#39;YmdHis&#39;, time()) . &#39;.&#39; . $file->getClientOriginalExtension();
            case 2:
                return Str::random(32) . &#39;.&#39; . $file->getClientOriginalExtension();
            case 3:
            default:
                return $file->getClientOriginalName();
        }
    }}

Use it where neededUploadToGithub

use UploadToGithub;public function updload(Request $request){
    $url = $this->uploadToGithub($request->file('file-field-name'));
    
    return response()->json([
        'code' => 200,
        'message' => '上传成功',
        'data' => [
            'url' => $url
        ]
    ]);}

The latest five Laravel Video tutorial(recommended)                                    

(string)
status code	##email (string)Required - Email of the submission's author or submitter. If email
	date (string)

The above is the detailed content of Talk about how Laravel integrates GitHub to store files. For more information, please follow other related articles on the PHP Chinese website!