All Projects → peter-evans → Swagger Github Pages

peter-evans / Swagger Github Pages

How to host Swagger API documentation with GitHub Pages

Projects that are alternatives of or similar to Swagger Github Pages

Hexo Theme Doc
A documentation theme for the Hexo blog framework
Stars: ✭ 222 (+117.65%)
Mutual labels:  swagger, swagger-ui, api-documentation
Pretty Swag
Pretty UI for Swagger spec
Stars: ✭ 112 (+9.8%)
Mutual labels:  swagger, swagger-ui, api-documentation
Openapi Viewer
Browse and test a REST API described with the OpenAPI 3.0 Specification
Stars: ✭ 82 (-19.61%)
Mutual labels:  swagger, swagger-ui, api-documentation
Angular Swagger Ui
An angularJS implementation of Swagger UI
Stars: ✭ 131 (+28.43%)
Mutual labels:  swagger, swagger-ui, api-documentation
Flasgger
Easy OpenAPI specs and Swagger UI for your Flask API
Stars: ✭ 2,825 (+2669.61%)
Mutual labels:  swagger, swagger-ui, api-documentation
Go Book Store Api
Go Sample project to understand Mysql CRUD operation with best practises Includes logging, JWT, Swagger and Transactions
Stars: ✭ 18 (-82.35%)
Mutual labels:  swagger, swagger-ui
Spark Swagger
Spark (http://sparkjava.com/) support for Swagger (https://swagger.io/)
Stars: ✭ 25 (-75.49%)
Mutual labels:  swagger, swagger-ui
Swagger Editor
Swagger Editor
Stars: ✭ 7,365 (+7120.59%)
Mutual labels:  swagger, swagger-ui
Molten Boilerplate
A boilerplate for the molten framework by Bogdanp https://github.com/Bogdanp/molten
Stars: ✭ 50 (-50.98%)
Mutual labels:  swagger, api-documentation
Swagger Ui
Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
Stars: ✭ 21,279 (+20761.76%)
Mutual labels:  swagger, swagger-ui
Fastapi
FastAPI framework, high performance, easy to learn, fast to code, ready for production
Stars: ✭ 39,588 (+38711.76%)
Mutual labels:  swagger, swagger-ui
Spring Boot Webflux Swagger Starter
An example project to illustrate how to document Spring Boot Webflux with Swagger2
Stars: ✭ 62 (-39.22%)
Mutual labels:  swagger, api-documentation
Django Ninja
💨 Fast, Async-ready, Openapi, type hints based framework for building APIs
Stars: ✭ 875 (+757.84%)
Mutual labels:  swagger, swagger-ui
Create Openapi Repo
🤖 Generator for GH repo to help you manage the OpenAPI definition lifecycle
Stars: ✭ 513 (+402.94%)
Mutual labels:  swagger, api-documentation
Spring Boot Elasticsearch Lire Docker
Spring-boot+ElasticSearch+LIRE+SwaggerUI RESTful.
Stars: ✭ 7 (-93.14%)
Mutual labels:  swagger, swagger-ui
Swagger Ui Themes
💥 A collection of css themes to spice up your Swagger docs
Stars: ✭ 470 (+360.78%)
Mutual labels:  swagger, swagger-ui
Swagger Ui Cimpress
A swagger-ui fork with an easy to read, responsive three pane view.
Stars: ✭ 32 (-68.63%)
Mutual labels:  swagger, swagger-ui
Swagger ui engine
Include swagger-ui as rails engine and document your API with simple JSON or YAML files.
Stars: ✭ 77 (-24.51%)
Mutual labels:  swagger, swagger-ui
Dorado
基于Netty4开发的简单、轻量级、高性能的的Http restful api server
Stars: ✭ 65 (-36.27%)
Mutual labels:  swagger, swagger-ui
Grape Doorkeeper
Get to API building quickly
Stars: ✭ 77 (-24.51%)
Mutual labels:  swagger, swagger-ui

How to host Swagger API documentation with GitHub Pages

The blog of Peter Evans: How to Host Swagger Documentation With Github Pages

This repository is a template for using the Swagger UI to dynamically generate beautiful documentation for your API and host it for free with GitHub Pages.

The template will periodically auto-update the Swagger UI dependency and create a pull request. See the GitHub Actions workflow here.

The example API specification used by this repository can be seen hosted at https://peter-evans.github.io/swagger-github-pages.

Steps to use this template

  1. Click the Use this template button above to create a new repository from this template.

  2. Go to the settings for your repository at https://github.com/{github-username}/{repository-name}/settings and enable GitHub Pages.

    Headers

  3. Browse to the Swagger documentation at https://{github-username}.github.io/{repository-name}/.

Steps to manually configure in your own repository

  1. Download the latest stable release of the Swagger UI here.

  2. Extract the contents and copy the "dist" directory to the root of your repository.

  3. Move the file "index.html" from the directory "dist" to the root of your repository.

    mv dist/index.html .
    
  4. Copy the YAML specification file for your API to the root of your repository.

  5. Edit index.html and change the url property to reference your local YAML file.

        const ui = SwaggerUIBundle({
            url: "swagger.yaml",
        ...
    

    Then fix any references to files in the "dist" directory.

    ...
    <link rel="stylesheet" type="text/css" href="dist/swagger-ui.css" >
    <link rel="icon" type="image/png" href="dist/favicon-32x32.png" sizes="32x32" />
    <link rel="icon" type="image/png" href="dist/favicon-16x16.png" sizes="16x16" />    
    ...
    <script src="dist/swagger-ui-bundle.js"> </script>
    <script src="dist/swagger-ui-standalone-preset.js"> </script>    
    ...
    
  6. Go to the settings for your repository at https://github.com/{github-username}/{repository-name}/settings and enable GitHub Pages.

    Headers

  7. Browse to the Swagger documentation at https://{github-username}.github.io/{repository-name}/.

    The example API specification used by this repository can be seen hosted at https://peter-evans.github.io/swagger-github-pages.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].