1 Commits

Author SHA1 Message Date
4f4b959e9e successfully moved to openapi 3.0.0 2021-01-24 23:24:20 +01:00
3 changed files with 228 additions and 274 deletions

View File

@ -20,9 +20,7 @@ RUN \
pip3 install connexion && \ pip3 install connexion && \
pip3 install connexion[swagger-ui] && \ pip3 install connexion[swagger-ui] && \
pip3 install uwsgi && \ pip3 install uwsgi && \
pip3 install flask-cors && \ pip3 install flask-cors
pip3 install python-jose[cryptography] && \
pip3 install six
RUN \ RUN \
mkdir -p ${APP_DIR} && \ mkdir -p ${APP_DIR} && \

44
auth.py
View File

@ -1,44 +0,0 @@
import time
import connexion
import six
from werkzeug.exceptions import Unauthorized
from jose import JWTError, jwt
JWT_ISSUER = 'de.hottis.hausverwaltung'
JWT_SECRET = 'streng_geheim'
JWT_LIFETIME_SECONDS = 600
JWT_ALGORITHM = 'HS256'
def generate_token(user_id):
timestamp = _current_timestamp()
payload = {
"iss": JWT_ISSUER,
"iat": int(timestamp),
"exp": int(timestamp + JWT_LIFETIME_SECONDS),
"sub": str(user_id),
}
return jwt.encode(payload, JWT_SECRET, algorithm=JWT_ALGORITHM)
def decode_token(token):
try:
return jwt.decode(token, JWT_SECRET, algorithms=[JWT_ALGORITHM])
except JWTError as e:
six.raise_from(Unauthorized, e)
def get_secret(user, token_info) -> str:
return '''
You are user_id {user} and the secret is 'wbevuec'.
Decoded token claims: {token_info}.
'''.format(user=user, token_info=token_info)
def _current_timestamp() -> int:
return int(time.time())

View File

@ -1,7 +1,7 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: Hausverwaltung-JWT title: Hausverwaltung
version: "0.2" version: "0.1"
paths: paths:
/hv/objekte: /hv/objekte:
@ -12,10 +12,12 @@ paths:
responses: responses:
200: 200:
description: Successful response. description: Successful response.
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/components/Objekt' type: array
items:
$ref: '#/components/schemas/Objekt'
404: 404:
description: No Objekte available description: No Objekte available
500: 500:
@ -28,13 +30,16 @@ paths:
parameters: parameters:
- name: id - name: id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
schema: content:
$ref: '#/components/Objekt' 'application/json':
schema:
$ref: '#/components/schemas/Objekt'
404: 404:
description: Objekt not found description: Objekt not found
500: 500:
@ -47,10 +52,12 @@ paths:
responses: responses:
200: 200:
description: Successful response. description: Successful response.
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/components/Wohnung' type: array
items:
$ref: '#/components/schemas/Wohnung'
404: 404:
description: No Wohnung available description: No Wohnung available
500: 500:
@ -63,15 +70,18 @@ paths:
parameters: parameters:
- name: id - name: id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/components/Wohnung' type: array
items:
$ref: '#/components/schemas/Wohnung'
404: 404:
description: No Wohnung available description: No Wohnung available
500: 500:
@ -84,13 +94,16 @@ paths:
parameters: parameters:
- name: id - name: id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
schema: content:
$ref: '#/components/Wohnung' 'application/json':
schema:
$ref: '#/components/schemas/Wohnung'
404: 404:
description: Wohnung not found description: Wohnung not found
500: 500:
@ -103,10 +116,12 @@ paths:
responses: responses:
200: 200:
description: Successful response. description: Successful response.
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/components/Mieter' type: array
items:
$ref: '#/components/schemas/Mieter'
404: 404:
description: No Mieter available description: No Mieter available
500: 500:
@ -119,13 +134,16 @@ paths:
parameters: parameters:
- name: id - name: id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
schema: content:
$ref: '#/components/Mieter' 'application/json':
schema:
$ref: '#/components/schemas/Mieter'
404: 404:
description: Mieter not found description: Mieter not found
500: 500:
@ -138,13 +156,16 @@ paths:
parameters: parameters:
- name: id - name: id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
schema: content:
$ref: '#/components/Forderung' 'application/json':
schema:
$ref: '#/components/schemas/Forderung'
404: 404:
description: Forderung not found description: Forderung not found
500: 500:
@ -157,15 +178,18 @@ paths:
parameters: parameters:
- name: mieter_id - name: mieter_id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/components/Forderung' type: array
items:
$ref: '#/components/schemas/Forderung'
404: 404:
description: No Forderung available description: No Forderung available
500: 500:
@ -178,13 +202,16 @@ paths:
parameters: parameters:
- name: id - name: id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
schema: content:
$ref: '#/components/Zahlung' 'application/json':
schema:
$ref: '#/components/schemas/Zahlung'
404: 404:
description: Zahlung not found description: Zahlung not found
500: 500:
@ -197,15 +224,18 @@ paths:
parameters: parameters:
- name: mieter_id - name: mieter_id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response. description: Successful response.
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/components/Zahlung' type: array
items:
$ref: '#/components/schemas/Zahlung'
404: 404:
description: No Zahlung available description: No Zahlung available
500: 500:
@ -218,19 +248,23 @@ paths:
parameters: parameters:
- name: mieter_id - name: mieter_id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
- name: year - name: year
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response description: Successful response
schema: content:
type: array 'application/json':
items: schema:
$ref: '#/components/ZahlungForderung' type: array
items:
$ref: '#/components/schemas/ZahlungForderung'
404: 404:
description: No ZahlungForderung available description: No ZahlungForderung available
500: 500:
@ -243,193 +277,159 @@ paths:
parameters: parameters:
- name: mieter_id - name: mieter_id
in: path in: path
type: integer
required: true required: true
schema:
type: integer
- name: year - name: year
in: path in: path
type: integer
required: true required: true
schema:
type: integer
responses: responses:
200: 200:
description: Successful response description: Successful response
schema: content:
$ref: '#/components/Saldo' 'application/json':
schema:
$ref: '#/components/schemas/Saldo'
404: 404:
description: Neither Forderungen nor Zahlungen available description: Neither Forderungen nor Zahlungen available
500: 500:
description: Some server error description: Some server error
/hv/zahlung: # /hv/zahlung:
post: # post:
tags: [ "Zahlung" ] # tags: [ "Zahlung" ]
operationId: ZahlungenForderungen.put_zahlung # operationId: ZahlungenForderungen.put_zahlung
summary: Inserts a new Zahlung # summary: Inserts a new Zahlung
parameters: # parameters:
- name: zahlung # - name: zahlung
in: body # in: body
schema: # schema:
$ref: '#/components/Zahlung' # $ref: '#/components/schemas/Zahlung'
responses: # responses:
202: # 202:
description: Zahlung successfully inserted # description: Zahlung successfully inserted
500: # 500:
description: Some server or database error # description: Some server or database error
/auth/{user_id}:
get:
tags: [ "jwt" ]
summary: Return JWT token
operationId: auth.generate_token
parameters:
- name: user_id
description: User unique identifier
in: path
required: true
example: 12
schema:
type: integer
responses:
'200':
description: JWT token
content:
'text/plain':
schema:
type: string
/secret:
get:
tags: [ "jwt" ]
summary: Return secret string
operationId: auth.get_secret
responses:
'200':
description: secret response
content:
'text/plain':
schema:
type: string
security:
- jwt: ['secret']
components: components:
Objekt: schemas:
description: Objekt type Objekt:
type: object description: Objekt type
properties: type: object
id: properties:
type: integer id:
shortname: type: integer
type: string shortname:
flaeche: type: string
type: number flaeche:
Wohnung: type: number
description: Wohnung type Wohnung:
type: object description: Wohnung type
properties: type: object
id: properties:
type: integer id:
objekt: type: integer
type: integer objekt:
shortname: type: integer
type: string shortname:
flaeche: type: string
type: number flaeche:
objekt_shortname: type: number
type: string objekt_shortname:
Mieter: type: string
description: Mieter type Mieter:
type: object description: Mieter type
properties: type: object
id: properties:
type: integer id:
objekt: type: integer
type: integer objekt:
wohnung: type: integer
type: integer wohnung:
wohnung_shortname: type: integer
type: string wohnung_shortname:
objekt_shortname: type: string
type: string objekt_shortname:
anrede: type: string
type: string anrede:
vorname: type: string
type: string vorname:
nachname: type: string
type: string nachname:
strasse: type: string
type: string strasse:
plz: type: string
type: string plz:
ort: type: string
type: string ort:
telefon: type: string
type: string telefon:
einzug: type: string
type: string einzug:
auszug: type: string
type: string auszug:
Forderung: type: string
description: Forderung type Forderung:
type: object description: Forderung type
properties: type: object
id: properties:
type: integer id:
mieter: type: integer
type: integer mieter:
datum: type: integer
type: string datum:
betrag: type: string
type: number betrag:
kommentar: type: number
type: string kommentar:
ref_wohnung: type: string
type: number ref_wohnung:
Zahlung: type: number
description: Zahlung type Zahlung:
type: object description: Zahlung type
properties: type: object
id: properties:
type: integer id:
mieter: type: integer
type: integer mieter:
datum_ist: type: integer
type: string datum_ist:
datum_soll: type: string
type: string datum_soll:
betrag: type: string
type: number betrag:
kommentar: type: number
type: string kommentar:
ZahlungForderung: type: string
description: ZahlungForderung type ZahlungForderung:
type: object description: ZahlungForderung type
properties: type: object
zf_type: properties:
type: string zf_type:
id: type: string
type: integer id:
datum_soll: type: integer
type: string datum_soll:
datum_ist: type: string
type: string datum_ist:
betrag_zahlung: type: string
type: number betrag_zahlung:
betrag_forderung: type: number
type: number betrag_forderung:
kommentar: type: number
type: string kommentar:
mieter: type: string
type: number mieter:
Saldo: type: number
description: Saldo type Saldo:
type: object description: Saldo type
properties: type: object
forderungen: properties:
type: number forderungen:
zahlungen: type: number
type: number zahlungen:
saldo: type: number
type: number saldo:
securitySchemes: type: number
jwt:
type: http
scheme: bearer
bearerFormat: JWT
x-bearerInfoFunc: auth.decode_token