Pre-release
This release is a pre-release and may not be stable for production use.
# falsy
FAL.S.Y
### description
it's an api framework.
using falcon, swagger, yaml together!
### license
MIT and Apache v2
### showtime
### how to install it
`pip install falsy`
### how to use it
0. create the dir for static
`mkdir static`
1. writting the server code(main.py)
```python
from falsy.falsy import FALSY
f = FALSY() #you need create the dir called static before you run
f.swagger('test.yml', ui=True, theme='impress') #impress theme is the responsive swagger ui, or you can use 'normal' here
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 {
'get': 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
### extensions
there some improvements compare to standard swagger,
you can define `operationId` for handler, 'beforeId' and 'afterId' for aop hooks,
and 'validationId' for validator, see the files in demo dir for details.
FAL.S.Y
### description
it's an api framework.
using falcon, swagger, yaml together!
### license
MIT and Apache v2
### showtime
### how to install it
`pip install falsy`
### how to use it
0. create the dir for static
`mkdir static`
1. writting the server code(main.py)
```python
from falsy.falsy import FALSY
f = FALSY() #you need create the dir called static before you run
f.swagger('test.yml', ui=True, theme='impress') #impress theme is the responsive swagger ui, or you can use 'normal' here
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 {
'get': 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
### extensions
there some improvements compare to standard swagger,
you can define `operationId` for handler, 'beforeId' and 'afterId' for aop hooks,
and 'validationId' for validator, see the files in demo dir for details.
1 maintainer
Metadata
1 maintainer
Release files for falsy 2017.4.17.dev102
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| falsy-2017.4.17.dev102-py3-none-any.whl | Python 3 | none | any | Details |
Release files / falsy-2017.4.17.dev102-py3-none-any.whl
| Download URL | falsy-2017.4.17.dev102-py3-none-any.whl |
|---|---|
| Size | 2.5 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ce21fb42bae50eab97b564213538f8ab8d4ae39325ac15690351468641a2fbea
|
|
BLAKE2b-256 checksum How to use checksums |
9772984dc3c9378f0da53984e63615fd6a15348ec34924fa37581afd1fe20d02
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
