flask-restful-swagger
A Swagger spec extractor for flask-restful
파일 탐색기
최종 버전 다운로드 (.zip)- docker27.yml
- docker37.yml
- requirements-dev.txt
- requirements.txt
- .bash_customize
- .bash_git
- .bash_profile
- .bashrc
- README.md
- DEVELOPMENT.md
- Dockerfile
- basic.py
- blueprints.py
- inheritance.py
- highlight.default.css
- hightlight.default.css
- screen.css
- explorer_icons.png
- logo_small.png
- pet_store_api.png
- throbber.gif
- wordnik_api.png
- content.js
- backbone-min.js
- handlebars-1.0.0.js
- highlight.7.3.pack.js
- jquery-1.8.0.min.js
- jquery.ba-bbq.min.js
- jquery.slideto.min.js
- jquery.wiggle.min.js
- shred.bundle.js
- swagger-oauth.js
- swagger.js
- underscore-min.js
- .gitignore
- endpoint.html
- index.html
- o2c.html
- swagger-ui.js
- swagger-ui.min.js
- __init__.py
- container_boot.sh
- swagger.py
- common.sh
- upload.sh
- wheel.sh
- pre-commit
- Makefile
- commander.sh
- dev
- hightlight.default.css
- screen.css
- logo_small.png
- pet_store_api.png
- throbber.gif
- wordnik_api.png
- content.js
- all.js
- backbone-min.js
- handlebars-1.0.rc.1.js
- highlight.7.3.pack.js
- jquery-1.8.0.min.js
- jquery.ba-bbq.min.js
- jquery.slideto.min.js
- jquery.wiggle.min.js
- shred.bundle.js
- swagger-ui.js
- swagger.js
- underscore-min.js
- docs.html
- resources.json
- __init__.py
- helpers.py
- __init__.py
- fixtures_add_model.py
- test_add_model.py
- test_deduce_swagger_type.py
- test_deduce_swagger_type_flat.py
- test_docs.py
- test_extract_path_arguments.py
- test_extract_swagger_path.py
- test_get_current_registry.py
- test_make_class.py
- test_merge_parameter_list.py
- test_model.py
- test_nested_class.py
- test_nested_func.py
- test_operation.py
- test_parse_docs.py
- test_register_once.py
- test_render_endpoint.py
- test_render_hompage.py
- test_render_page.py
- test_resource_lister.py
- test_sanitize_doc.py
- test_staticfiles.py
- test_swagger_endpoint_class.py
- test_swagger_endpoint_func.py
- test_swagger_registry.py
- .bandit.rc
- .coveragerc
- .dockerignore
- .flake8
- .gitignore
- .isort.cfg
- CODE_OF_CONDUCT.md
- container
- CONTRIBUTING.md
- development.env
- docker-compose.yml
- LICENSE
- MANIFEST
- MANIFEST.in
- Pipfile
- pytest.ini
- README
- README.md
- setup.py
- TODO
# 설치 가이드
1. 코드 내려받기
git clone https://github.com/rantav/flask-restful-swagger
깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.
cd flask-restful-swagger
방금 내려받은 프로젝트 폴더 안으로 이동합니다.
2. 공식 설치 스크립트
쉬움 추천사전 준비물
- Python 3 pip 명령어를 쓰려면 Python이 필요합니다.
pip install flask-restful-swagger
PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.
설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
3. Docker
쉬움사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker compose up -d --build
정의된 모든 컨테이너(서버, DB 등)를 한 번에 빌드하고 백그라운드에서 실행합니다.
터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.
4. Python
쉬움사전 준비물
pip install flask-restful-swagger
PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.
에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
5. Make
보통사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.
⚠️ 이 프로젝트는 규모가 큰 저장소라, 이 방법이 실제 핵심 제품이 아니라 내부 하위 패키지를 가리키는 것일 수 있습니다. README 전체를 함께 확인해보세요.
cd scripts/releases
이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.
make
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.
// repository documentation
Was this content helpful?
(0 ratings)
