falcon.swagger.yaml
Project description
# falsy
FAL.S.Y
### description
it's a api framework.
using falcon, swagger, yaml together!
### license
MIT and Apache v2
### showtime
![ScreenShot](https://raw.githubusercontent.com/pingf/falsy/master/demo.gif)
### how to install it
`pip install falsy`
### how to use it
1. writting the server code(main.py)
```python
from falsy.falsy import FALSY
f = FALSY(static_path='test', static_dir='static') #you need create the dir called static before you run
f.begin_api()
f.swagger('test.yml', ui=True,theme='impress') #impress theme is the responsive swagger ui, or you can use 'normal' here
f.end_api()
api = f.api
```
2. writting the yml file
```
swagger: '2.0'
info:
title: FALSY SIMPLE DEMO API
version: "0.1"
consumes:
- application/json
produces:
- application/json
basePath: "/v1"
paths:
'/hello':
get:
tags: [Method]
operationId: demo.get_it
summary: testing
parameters:
- name: name
in: query
type: string
default: 'john'
responses:
200:
description: Return response
```
3. writting the operation handler(demo.py)
```python
def get_it(name):
return {
'name': name
}
```
4. run it
`gunicorn -b 0.0.0.0:8001 main:api --reload -w 1 --threads 1`
5. visit the ui page
`http://0.0.0.0:8001/v1/ui/`
make sure it ends with '/'
### video demo
![ScreenShot](https://raw.githubusercontent.com/pingf/falsy/master/falsy.gif)
FAL.S.Y
### description
it's a api framework.
using falcon, swagger, yaml together!
### license
MIT and Apache v2
### showtime
![ScreenShot](https://raw.githubusercontent.com/pingf/falsy/master/demo.gif)
### how to install it
`pip install falsy`
### how to use it
1. writting the server code(main.py)
```python
from falsy.falsy import FALSY
f = FALSY(static_path='test', static_dir='static') #you need create the dir called static before you run
f.begin_api()
f.swagger('test.yml', ui=True,theme='impress') #impress theme is the responsive swagger ui, or you can use 'normal' here
f.end_api()
api = f.api
```
2. writting the yml file
```
swagger: '2.0'
info:
title: FALSY SIMPLE DEMO API
version: "0.1"
consumes:
- application/json
produces:
- application/json
basePath: "/v1"
paths:
'/hello':
get:
tags: [Method]
operationId: demo.get_it
summary: testing
parameters:
- name: name
in: query
type: string
default: 'john'
responses:
200:
description: Return response
```
3. writting the operation handler(demo.py)
```python
def get_it(name):
return {
'name': name
}
```
4. run it
`gunicorn -b 0.0.0.0:8001 main:api --reload -w 1 --threads 1`
5. visit the ui page
`http://0.0.0.0:8001/v1/ui/`
make sure it ends with '/'
### video demo
![ScreenShot](https://raw.githubusercontent.com/pingf/falsy/master/falsy.gif)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for falsy-2017.1.2.dev17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85270000cd51948fbc661d193a313ff1d74f3cb94cfec490cbe4f09996a2f788 |
|
MD5 | 5849b5a974ac122f020068efa162ef23 |
|
BLAKE2b-256 | f62dfb15593e4eb1e6f05c68c24649b5d677e1c5077acbaf0b7e33bdc623dfa4 |