Skip to content

feat: add OpenAPI docs and Scalar API Reference under /docs #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sametcn99 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add OpenAPI docs and Scalar API Reference under /docs #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion api/index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from flask import Flask
from flask import Flask, send_from_directory
from flask_cors import CORS
import logging
import api.config
Expand All @@ -25,5 +25,34 @@
def home():
return 'Hello, World!'

@app.route('/openapi.json')
def openapi():
return send_from_directory(app.root_path, 'openapi.json')

@app.route('/docs')
def api_docs():
return '''
<!doctype html>
<html>
<head>
<title>Letterboxd API Reference</title>
<meta charset="utf-8" />
<meta
name="viewport"
content="width=device-width, initial-scale=1" />
<style>
body { margin: 0; }
</style>
</head>
<body>
<script
id="api-reference"
data-url="/openapi.json"></script>
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
</body>
</html>
'''


if __name__ == '__main__':
app.run(debug=(api.config.ENV == 'dev'), port=api.config.PORT)
Loading