https://github.com/HiDeoo/starlight-openapi

Starlight plugin to generate documentation from OpenAPI/Swagger specifications
https://github.com/HiDeoo/starlight-openapi

astro documentation openapi plugin starlight swagger

Last synced: about 1 month ago
JSON representation

Starlight plugin to generate documentation from OpenAPI/Swagger specifications

• Host: GitHub
• URL: https://github.com/HiDeoo/starlight-openapi
• Owner: HiDeoo
• License: mit
• Created: 2023-08-07T12:40:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-16T14:24:34.000Z (2 months ago)
• Last Synced: 2024-10-29T15:31:46.605Z (about 2 months ago)
• Topics: astro, documentation, openapi, plugin, starlight, swagger
• Language: TypeScript
• Homepage: https://starlight-openapi.vercel.app
• Size: 1.07 MB
• Stars: 111
• Watchers: 4
• Forks: 14
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
starlight-openapi 🧭

  
Starlight plugin to generate documentation from OpenAPI/Swagger specifications.

  


    

      

    

  





  

    

  

  

    

  

  




## Getting Started

Want to get started immediately? Check out the [getting started guide](https://starlight-openapi.vercel.app/getting-started/) or check out the [demo](https://starlight-openapi.vercel.app/api/petstore/operations/addpet/) to see the plugin in action.

## Features

A [Starlight](https://starlight.astro.build) plugin to generate documentation from OpenAPI/Swagger specifications.

- Support for [Swagger 2.0](https://swagger.io/specification/v2/), [OpenAPI 3.0](https://swagger.io/specification/v3/) and [OpenAPI 3.1](https://swagger.io/specification/) specifications.

- Support for local and remote schemas.

- Configurable sidebar label and sidebar group collapsing.

## License

Licensed under the MIT License, Copyright © HiDeoo.

See [LICENSE](https://github.com/HiDeoo/starlight-openapi/blob/main/LICENSE) for more information.