{"id":20598415,"url":"https://github.com/kkirsche/openapi-demo","last_synced_at":"2025-10-13T11:38:53.575Z","repository":{"id":52701962,"uuid":"197393014","full_name":"kkirsche/openapi-demo","owner":"kkirsche","description":"This is a demo repository for working with the OpenAPI spec","archived":false,"fork":false,"pushed_at":"2021-04-20T18:22:17.000Z","size":17,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-02T02:50:08.626Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kkirsche.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-17T13:16:02.000Z","updated_at":"2019-08-06T19:05:36.000Z","dependencies_parsed_at":"2022-08-22T07:21:50.053Z","dependency_job_id":null,"html_url":"https://github.com/kkirsche/openapi-demo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/kkirsche/openapi-demo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kkirsche%2Fopenapi-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kkirsche%2Fopenapi-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kkirsche%2Fopenapi-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kkirsche%2Fopenapi-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kkirsche","download_url":"https://codeload.github.com/kkirsche/openapi-demo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kkirsche%2Fopenapi-demo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279014804,"owners_count":26085594,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T08:26:46.608Z","updated_at":"2025-10-13T11:38:53.557Z","avatar_url":"https://github.com/kkirsche.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPI Demonstration Application\n\nThis application is designed to assist with learning how to work with the OpenAPI standard.\n\n## Usage\n\n### Application\n\nTo use the application locally, the following commands (prefixed by `$` to indicate that these should be run from a terminal):\n\n```shell\n$ python3 -m venv venv\n$ source ./venv/bin/activate\n$ python3 -m pip -r requirements.txt\n$ export FLASK_APP=main.py\n$ flask run\n```\n\nThis will begin the application on port 5000 bound to localhost (127.0.0.1).\n\n### Unit Tests\n\nTo run the unit tests for the API, the following commands may be used. This assumes that the virtual environment from the Application Usage was not completed yet.\n\n```shell\n$ python3 -m venv venv\n$ source ./venv/bin/activate\n$ python3 -m pip -r requirements.txt\n$ pytest -v\n```\n\n## Endpoints\n\nThis application exposes the following endpoints on the host running the application:\n\n* `GET /api/v1/fighters` - List fighters\n* `GET /api/v1/fighters/{id}` - Show fighter\n* `POST /api/v1/fighters` - Create fighter\n* `PUT /api/v1/fighters/{id}` - Update fighter\n* `DELETE /api/v1/fighters/{id}` - Destroy fighter\n\n## Structures\n### Fighter\n\nA fighter includes the following information:\n\n* `id` - The numeric ID representing the entry\n* `name` - The fighter's name\n* `weightclass` - The fighter's weightclass\n\nAn example of a fighter would be:\n\n```json\n{\n  \"id\": 1,\n  \"name\": \"Jon Jones\",\n  \"weightclass\": \"Light heavyweight (205 lbs)\"\n}\n```\n\n### Error\n\nAn error includes the following information:\n\n* `error` - The error message\n\nAn example of an error would be:\n\n```json\n{\n  \"error\": \"404 - Not Found\"\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkkirsche%2Fopenapi-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkkirsche%2Fopenapi-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkkirsche%2Fopenapi-demo/lists"}