pipoket pipoket

## beautiful.rest.api.docs.in.markdown.md

      
              1 file
            
          
              29 forks
            
          
              7 comments
            
          
              135 stars
            
          
                azagniotov
                / beautiful.rest.api.docs.in.markdown.md
            
            
              Last active
              June 30, 2024 05:39
            
              
                Example to create beautiful REST API docs in Markdown, inspired by Swagger API docs.
              
          
    Create beautiful REST API docs authored in Markdown


Adopted from: https://stubby4j.com/docs/admin_portal.html
Inspired by Swagger API docs style & structure: https://petstore.swagger.io/#/pet


Creating new/overwriting existing stubs & proxy configs


## example.py
"""
Flask's reloader causes kernprof to fail.
Without the reloader it appears to work.
"""

from flask import Flask, request
import time

app = Flask(__name__)
app.testing = True

## nginx.conf
# to generate your dhparam.pem file, run in the terminal
openssl dhparam -out /etc/nginx/ssl/dhparam.pem 2048

## flume.py
#!/usr/bin/env python
#
# tap -> flume
#
# requires: python thrift bindings + compiled flume thrift binding.
#

import sys
import time
import struct
	"""
	Flask's reloader causes kernprof to fail.
	Without the reloader it appears to work.
	"""

	from flask import Flask, request
	import time

	app = Flask(__name__)
	app.testing = True
	# to generate your dhparam.pem file, run in the terminal
	openssl dhparam -out /etc/nginx/ssl/dhparam.pem 2048
	#!/usr/bin/env python
	#
	# tap -> flume
	#
	# requires: python thrift bindings + compiled flume thrift binding.
	#

	import sys
	import time
	import struct