API

This repository contains the source code of the Yolo API.

The Yolo API is hosted in a private server in the sole goal of implementing the GitHub OAuth flow in a secured manner (ie: without exposing our GitHub secret in the CLI).

The base URL for the API is: https://api.yo-lo.sh

Table of contents

• Requirements
• Usage
• API
  • Routes
  • GitHub OAuth flow
• License

Requirements

• go >= 1.17

Usage

To use the Yolo API, the following steps need to be taken:

1. Clone the GitHub repository using: git clone https://github.com/yolo-sh/api.git.

2. Create a file named .env at the root of the repository. (This file will contain the environment variables required by the API).

3. Use the .env.dist file to add the required environment variables to your .env file.

4. Launch the API server using the command go run main.go. The server will listen on http://127.0.0.1:8080 by default.

API

The Yolo API is implemented using the Gin Web Framework.

Routes

GET /github/oauth/callback

This is the sole route defined. This is where you will be redirected after authorizing the Yolo application on GitHub.

The GitHub OAuth code will be exchanged for an access token and transmited to the Yolo CLI using an HTTP redirect.

GitHub OAuth flow

The GitHub OAuth flow is a multi-step process between the Yolo CLI, GitHub and the Yolo API:

1. First, the Yolo CLI will create an HTTP server that will listen for connections on 127.0.0.1:${RANDOM_PORT}.

2. Then, the Yolo CLI will redirect you to GitHub to authorize the Yolo application.

3. Once authorized, GitHub will redirect you to the Yolo API that will exchange to passed OAuth code for an access token.

4. Once done, the Yolo API will pass the received access token to the Yolo CLI by redirecting you to http://127.0.0.1:${RANDOM_PORT}?access_token=${GITHUB_ACCESS_TOKEN}.

Given that GitHub doesn't support dynamic OAuth redirect uris, the random port used by the CLI is passed to the API via the OAuth state parameter.

License

Yolo is available as open source under the terms of the MIT License.