All Projects → moon0326 → Swagger Ui Watcher

moon0326 / Swagger Ui Watcher

Automatically refreshes Swagger UI on Swagger file changes

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to Swagger Ui Watcher

Vs Swagger Viewer
Swagger Viewer lets you preview and validate Swagger 2.0 and OpenAPI files as you type in Visual Studio Code.
Stars: ✭ 126 (-6.67%)
Mutual labels:  swagger
Angular Swagger Ui
An angularJS implementation of Swagger UI
Stars: ✭ 131 (-2.96%)
Mutual labels:  swagger
Sw2dts
Generates TypeScript definition file(d.ts) from swagger.json for edge cases.
Stars: ✭ 132 (-2.22%)
Mutual labels:  swagger
Client Python
A python client library for accessing Polygon's APIs
Stars: ✭ 127 (-5.93%)
Mutual labels:  swagger
Laravel Swagger
Auto generates the swagger documentation of a laravel project based on best practices and simple assumptions
Stars: ✭ 129 (-4.44%)
Mutual labels:  swagger
Jiiiiiin Security
一个前后端分离的内管基础项目
Stars: ✭ 132 (-2.22%)
Mutual labels:  swagger
Grpc Gateway
The gRPC-Gateway is a plugin of the Google protocol buffers compiler protoc. It reads protobuf service definitions and generates a reverse-proxy server which translates a RESTful HTTP API into gRPC. This server is generated according to the google.api.http annotations in your service definitions.
Stars: ✭ 12,223 (+8954.07%)
Mutual labels:  swagger
Ruoyi Oracle
(RuoYi)官方仓库 基于SpringBoot的权限管理系统 易读易懂、界面简洁美观。 核心技术采用Spring、MyBatis、Shiro没有任何其它重度依赖。直接运行即可用
Stars: ✭ 134 (-0.74%)
Mutual labels:  swagger
Swagger Inflector
Stars: ✭ 131 (-2.96%)
Mutual labels:  swagger
Graphql Mesh
GraphQL Mesh — Query anything, run anywhere
Stars: ✭ 2,114 (+1465.93%)
Mutual labels:  swagger
Open Api Renderer
🎩 A React renderer for OpenAPI v3.
Stars: ✭ 127 (-5.93%)
Mutual labels:  swagger
Spring Boot Quick
🌿 基于springboot的快速学习示例,整合自己遇到的开源框架,如:rabbitmq(延迟队列)、Kafka、jpa、redies、oauth2、swagger、jsp、docker、spring-batch、异常处理、日志输出、多模块开发、多环境打包、缓存cache、爬虫、jwt、GraphQL、dubbo、zookeeper和Async等等📌
Stars: ✭ 1,819 (+1247.41%)
Mutual labels:  swagger
Mentorship Backend
Mentorship System is an application that matches women in tech to mentor each other, on career development, through 1:1 relations during a certain period of time. This is the backend of this system.
Stars: ✭ 132 (-2.22%)
Mutual labels:  swagger
Tsed
📐 Ts.ED is a Node.js and TypeScript framework on top of Express to write your application with TypeScript (or ES6). It provides a lot of decorators and guideline to make your code more readable and less error-prone.
Stars: ✭ 1,941 (+1337.78%)
Mutual labels:  swagger
Rapipdf
PDF generation from OpenAPI / Swagger Spec
Stars: ✭ 132 (-2.22%)
Mutual labels:  swagger
Covid 19 Api
API Service for tracking the COVID-19
Stars: ✭ 126 (-6.67%)
Mutual labels:  swagger
Jsonwatch
Track changes in JSON data from the command line
Stars: ✭ 130 (-3.7%)
Mutual labels:  watch
Terraform Provider Openapi
OpenAPI Terraform Provider that configures itself at runtime with the resources exposed by the service provider (defined in a swagger file)
Stars: ✭ 134 (-0.74%)
Mutual labels:  swagger
Go Codon
Workflow based REST framework code generator
Stars: ✭ 133 (-1.48%)
Mutual labels:  swagger
Restful React
A consistent, declarative way of interacting with RESTful backends, featuring code-generation from Swagger and OpenAPI specs 🔥
Stars: ✭ 1,814 (+1243.7%)
Mutual labels:  swagger

Swagger UI Watcher

Swagger UI Watcher detects changes in your local Swagger files and reload Swagger UI in your browser to give you fluid workflow. It is primarily developed to work with multiple Swagger files using $ref.

Why?

  • Using online Swagger Editor is annoying. You have to copy and paste your Swagger files back and forth.
  • Relative and local system $ref do not work with online Swagger Editor v3
  • Manually creating bundle from multiple Swagger files after each update is impractical and tiresome.
  • Using my editor/ide of choice is awesome.

Installation

Version Swagger Version
1.0.10 2
>=2.0 3
npm install swagger-ui-watcher -g

Usage

For watching the changes in target directory, following command is used

swagger-ui-watcher ./main-swagger-file.json

Additional Options

Command line argument Description
-p --port Default is 8000
-h --host <Hostname/IP> Defaults to 127.0.0.1
--no-open Do not open the view page in the default browser
-c --config <JSON_file> JSON file containing any of the Swagger UI options. Example: {"withCredentials": true}
-b --bundle Create bundle at the specified location

For creating the bundled file, provide the optional argument bundle

swagger-ui-watcher ./main-swagger-file.json --bundle=./bundled.json

Click the image to see it in action

Alt text

Do What You Want to Public License

               DO WHAT YOU WANT TO PUBLIC LICENSE
                    Version 3, January 2012

 Copyright (C) 2012 Ryan Thompson

 Everyone is permitted to copy and distribute verbatim or modified
 copies of this license document, and changing it is allowed as long
 as the name is changed.

                DO WHAT YOU WANT TO PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. You just DO WHAT YOU WANT TO.
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].