{"id":41283994,"url":"https://github.com/venmo/swaggergenerator","last_synced_at":"2026-01-23T02:58:33.175Z","repository":{"id":52705393,"uuid":"57395781","full_name":"venmo/swaggergenerator","owner":"venmo","description":"Create swagger / OpenAPI schemas from example interactions.","archived":false,"fork":false,"pushed_at":"2023-05-23T07:19:29.000Z","size":22,"stargazers_count":12,"open_issues_count":7,"forks_count":9,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-12-02T18:20:44.044Z","etag":null,"topics":["openapi","python","swagger"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/venmo.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-29T15:47:24.000Z","updated_at":"2025-04-01T04:31:50.000Z","dependencies_parsed_at":"2023-02-17T13:31:20.014Z","dependency_job_id":null,"html_url":"https://github.com/venmo/swaggergenerator","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/venmo/swaggergenerator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/venmo%2Fswaggergenerator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/venmo%2Fswaggergenerator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/venmo%2Fswaggergenerator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/venmo%2Fswaggergenerator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/venmo","download_url":"https://codeload.github.com/venmo/swaggergenerator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/venmo%2Fswaggergenerator/sbom","scorecard":{"id":918554,"data":{"date":"2025-08-11","repo":{"name":"github.com/venmo/swaggergenerator","commit":"0cc5441d79d0578d1ed0e092ef2c5db41447c5a2"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/8 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"29 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2018-66 / GHSA-562c-5r94-xh97","Warn: Project is vulnerable to: PYSEC-2019-179 / GHSA-5wv5-4vpf-pj6m","Warn: Project is vulnerable to: PYSEC-2023-62 / GHSA-m2qf-hxjv-5gpq","Warn: Project is vulnerable to: PYSEC-2019-217 / GHSA-462w-v97r-4m45","Warn: Project is vulnerable to: GHSA-cpwx-vrp4-4pq7","Warn: Project is vulnerable to: PYSEC-2021-66 / GHSA-g3rq-g295-4j3m","Warn: Project is vulnerable to: GHSA-h5c8-rqwp-cp95","Warn: Project is vulnerable to: GHSA-h75v-3vvj-5mfj","Warn: Project is vulnerable to: PYSEC-2019-220 / GHSA-hj2j-77xm-mc5v","Warn: Project is vulnerable to: GHSA-q2x7-8rv6-6q7h","Warn: Project is vulnerable to: PYSEC-2020-92 / GHSA-hj5v-574p-mj7c","Warn: Project is vulnerable to: PYSEC-2022-42969","Warn: Project is vulnerable to: PYSEC-2021-142 / GHSA-8q59-q68h-6hv4","Warn: Project is vulnerable to: PYSEC-2018-49 / GHSA-rprw-h62v-c2w7","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2023-74 / GHSA-j8r2-6x86-q33q","Warn: Project is vulnerable to: PYSEC-2018-28 / GHSA-x84v-xcm2-53pg","Warn: Project is vulnerable to: GHSA-2g68-c3qc-8985","Warn: Project is vulnerable to: GHSA-f9vj-2wh5-fj8j","Warn: Project is vulnerable to: PYSEC-2019-140 / GHSA-gq9m-qvpx-68hc","Warn: Project is vulnerable to: PYSEC-2017-43 / GHSA-h2fp-xgx6-xh6f","Warn: Project is vulnerable to: PYSEC-2023-221 / GHSA-hrfv-mqp8-q5rw","Warn: Project is vulnerable to: GHSA-j544-7q9p-6xp8","Warn: Project is vulnerable to: PYSEC-2023-57 / GHSA-px8h-6qxv-m22q","Warn: Project is vulnerable to: GHSA-q34m-jh98-gwm2","Warn: Project is vulnerable to: PYSEC-2023-58 / GHSA-xg9f-g7g7-2323","Warn: Project is vulnerable to: PYSEC-2022-203","Warn: Project is vulnerable to: PYSEC-2022-43017 / GHSA-qwmp-2cf2-g9g6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-24T23:04:05.381Z","repository_id":52705393,"created_at":"2025-08-24T23:04:05.381Z","updated_at":"2025-08-24T23:04:05.381Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28679139,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T01:00:35.747Z","status":"online","status_checked_at":"2026-01-23T02:00:08.296Z","response_time":59,"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":["openapi","python","swagger"],"created_at":"2026-01-23T02:58:32.449Z","updated_at":"2026-01-23T02:58:33.171Z","avatar_url":"https://github.com/venmo.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"swaggergenerator\n=================\n\n*[not actively supported outside of internal Venmo usage]*\n\nCreating swagger/OAS specs for an existing api by hand is tedious and error-prone.\nswaggergenerator fixes this by creating schemas from example interactions:\n\nGeneration is a three step process.\nHere's an example using `httpbin \u003chttps://httpbin.org/get\u003e`__:\n\n.. code-block:: python\n\n    import requests\n    from swaggergenerator import Generator, get_yaml\n\n    # 1: Create a Generator.\n    generator = Generator()\n\n    # 2: Provide one or more examples. They can be for different paths and verbs.\n    response = requests.get('https://httpbin.org/get')\n    generator.provide_example(response.request, response)\n\n    # 3: Generate a schema (specifically, a Swagger Paths Object).\n    print get_yaml(generator.generate_paths())\n\n.. code-block:: yaml\n\n  /get:\n    get:\n      description: TODO\n      parameters: []\n      responses:\n        '200':\n          description: TODO\n          schema:\n            additionalProperties: false\n            properties:\n              args:\n                additionalProperties: false\n                properties: {}\n                type: object\n              headers:\n                additionalProperties: false\n                properties:\n                  Accept:\n                    type: string\n                  Accept-Encoding:\n                    type: string\n                  Connection:\n                    type: string\n                  Content-Length:\n                    type: string\n                  Host:\n                    type: string\n                  User-Agent:\n                    type: string\n                type: object\n              origin:\n                type: string\n              url:\n                type: string\n            type: object\n\nYou can install it with ``$ pip install swaggergenerator``.\n\n\nGeneration details\n---------------------\n\nGenerally, the generated schemas err on the side of being too strict.\nFor example, additionalProperties is always set to False and parameters are always required.\nThe recommended workflow is to generate schemas, validate them against all interactions in your test suite, and iterate until tests pass.\n\nHere are the swagger features you can expect to be generated:\n\n- path objects for arbitrary verb/path combinations\n- all-digit path parameters\n- complex path parameters (when given alongside an all-digit example)\n- request schemas for 2xx responses\n- response schemas for 2xx responses\n- references to existing definitions\n\nHere are some swagger features that won't be generated.\nIf your api uses any of these, you'll need to fix up your output manually:\n\n- nullable/polymorphic types\n- heterogeneous arrays\n- optional properties\n- additionalProperties != False\n\n\nContributing\n------------\n\nInside your vitualenv:\n\n.. code-block:: bash\n\n    $ cd swaggergenerator\n    $ pip install -e .\n    $ pip install -r requirements.txt\n\n\nTo run the tests:\n\n.. code-block:: bash\n\n    $ py.test tests/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvenmo%2Fswaggergenerator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvenmo%2Fswaggergenerator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvenmo%2Fswaggergenerator/lists"}