{"repo":"Legion2/swagger-ui-action","free":true,"listed":false,"github":"https://github.com/Legion2/swagger-ui-action","clone":"git clone https://github.com/Legion2/swagger-ui-action.git","description":"Generate Swagger UI in a GitHub Actions workflow","language":"TypeScript","stars":59,"topics":["swagger-ui","github-page","workflow","actions","openapi","documentation-tool"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Swagger UI Action Generate Swagger UI static html files and configuration to be deployed to GitHub Pages. This action only works on linux runners. How to Use This Action supports four different configuration modes: - spec-file : File path to local OpenAPI or Swagger specification document - spec-url : URL of an OpenAPI or Swagger specification document - swagger-config-file : File path to local swagger configuration file - swagger-config-url : URL of a swagger configuration file Use spec-file or spec-url when you have an OpenAPI or Swagger specification document and want a basic Swagger UI generated for it. If you want to customize the created Swagger UI, you should use the swagger-config-file or the swagger-config-url configuration modes. For information about the advanced swagger-config see the Swagger UI Configuration documentation. Note that, if swagger-config-file or swagger-config-url are used, no files specified in the swagger-config.yaml are copied by this action. In this case, it is your responsibility to copy required files such as the OpenAPI document where you need them (output directory). The output directory of the generated Swagger UI must be set with the output argument of the Action. Version Input The version input controls which version of Swagger UI is used to generate the documentation. It accepts semver ranges, allowing you to specify exact versions (e.g., 5.0.0 ), major versions (e.g., 5.x ), or ranges (e.g., ^3.0.0 ). If not specified, it defaults to ^3","default_branch":null,"files":null,"tree":[],"storefront":"/r/Legion2","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Legion2/swagger-ui-action/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}