https://github.com/hey-api/upload-openapi-spec

Upload your OpenAPI specification to Hey API 🚀
https://github.com/hey-api/upload-openapi-spec

actions angular axios codegen fetch github javascript nodejs openapi swagger typescript xhr

Last synced: about 9 hours ago
JSON representation

Upload your OpenAPI specification to Hey API 🚀

• Host: GitHub
• URL: https://github.com/hey-api/upload-openapi-spec
• Owner: hey-api
• Created: 2024-04-13T18:15:45.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-04-20T08:03:52.000Z (9 months ago)
• Last Synced: 2025-01-07T20:14:41.216Z (8 days ago)
• Topics: actions, angular, axios, codegen, fetch, github, javascript, nodejs, openapi, swagger, typescript, xhr
• Language: TypeScript
• Homepage: https://heyapi.vercel.app
• Size: 1.11 MB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

  
Upload OpenAPI Specification

  
A GitHub Action that uploads your OpenAPI specifications to Hey API 🚀



To use this action, you have to be registered with

[Hey API](https://heyapi.vercel.app/). If you don't have an account, please

[email us](mailto:[email protected]) or

[open an issue](https://github.com/hey-api/upload-openapi-spec/issues) and we

will set you up.

## Usage

Create a new GitHub workflow or add an upload step to your existing workflow

inside your API codebase.

```yaml

name: Upload OpenAPI Specification

on:

  push:

    branches:

      - main

jobs:

  upload-openapi-spec:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v4

      - name: Upload OpenAPI spec

        uses: hey-api/upload-openapi-spec@v1

        with:

          hey-api-token: ${{ secrets.HEY_API_TOKEN }}

          path-to-openapi: path/to/openapi.json

```

The example above will send your OpenAPI spec to Hey API on every push to `main`

branch.

## Inputs

To successfully upload an OpenAPI specification, you need to provide the

following inputs (see `with` in the example above)

### `hey-api-token`

This is the authorization token you obtained from us.

### `path-to-openapi`

A relative path to your OpenAPI spec file within the repository. Note that you

might need an additional step in your GitHub workflow to generate this file (see

[FastAPI example](https://fastapi.tiangolo.com/how-to/extending-openapi/#generate-the-openapi-schema)).

## Next Steps

Please follow the

[integrations guide](https://heyapi.vercel.app/openapi-ts/integrations.html) on

our website for the next steps.