phwoolcon / swagger-editor-helper

Hack Swagger Editor to Provide View-only Mode

Swagger Editor Helper

Hack Swagger Editor to Provide View-only Mode.

I don't have enough time and nodejs working experience to contribute to Swagger Editor itself, so I just hack it by override the response in nginx.

The community looks not that easy:

• How can I export the HTML of the preview? #623 [ NOT WELCOME HERE ]
• Add a view only mode? #719 [ HACK it yourself ]
• Feature: Preview Only #795 [ IMPLEMENTED BUT REJECTED, WTF! ]

Usage

1. Install Swagger Editor by docker:

   docker pull swaggerapi/swagger-editor
   docker run -d -p 9010:8080 swaggerapi/swagger-editor

   This will run swagger-editor on port 9010
2. Copy nginx files to your nginx config directory:

   cp -r nginx/* /etc/nginx

3. Change server_name and root

   vim /etc/nginx/sites-enabled/swagger.conf

   ATTENTION: use public dir as root
4. Reload nginx

   nginx -t && nginx -s reload

HTTPS

If you want to access swagger via https, please:

1. Prepare SSL certificate;
2. Use swagger.https.conf:

   ln -snf ../sites-available/swagger.https.conf /etc/nginx/sites-enabled/swagger.conf

3. Change ssl_certificate and ssl_certificate_key to use real certificate;
4. Generate a dhparam file:

   sudo openssl dhparam -out /etc/nginx/ssl/dhparam.pem 4096

5. Then reload nginx:

   nginx -t && nginx -s reload

swagger-editor-helper's Issues

Enable View-only Mode for Swagger Editor

Guys want to use view-only mode please check my project.

Refer:
swagger-api/swagger-editor#623
swagger-api/swagger-editor#719
swagger-api/swagger-editor#795