{"id":15748006,"url":"https://github.com/jcs090218/swagger-it","last_synced_at":"2026-04-17T06:32:52.233Z","repository":{"id":97568371,"uuid":"234503312","full_name":"jcs090218/swagger-it","owner":"jcs090218","description":"Automatically generate the swagger.io yaml file for your project.","archived":false,"fork":false,"pushed_at":"2020-02-07T10:56:54.000Z","size":81,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-14T20:00:08.322Z","etag":null,"topics":["annotations","api","automation","documentation","openapi","swagger"],"latest_commit_sha":null,"homepage":"","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/jcs090218.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-17T08:18:50.000Z","updated_at":"2024-01-22T08:50:43.000Z","dependencies_parsed_at":"2023-04-05T00:45:52.128Z","dependency_job_id":null,"html_url":"https://github.com/jcs090218/swagger-it","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jcs090218/swagger-it","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcs090218%2Fswagger-it","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcs090218%2Fswagger-it/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcs090218%2Fswagger-it/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcs090218%2Fswagger-it/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jcs090218","download_url":"https://codeload.github.com/jcs090218/swagger-it/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcs090218%2Fswagger-it/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31918513,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-16T18:22:33.417Z","status":"online","status_checked_at":"2026-04-17T02:00:06.879Z","response_time":62,"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":["annotations","api","automation","documentation","openapi","swagger"],"created_at":"2024-10-04T05:40:20.436Z","updated_at":"2026-04-17T06:32:52.209Z","avatar_url":"https://github.com/jcs090218.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.com/jcs-workspace/swagger-it.svg?branch=master)](https://travis-ci.com/jcs-workspace/swagger-it)\n[![Unity Engine](https://img.shields.io/badge/python-%3E=_3.6-green.svg)](https://www.python.org/downloads/)\n[![Release Tag](https://img.shields.io/github/tag/jcs-workspace/swagger-it.svg?label=release)](https://github.com/jcs-workspace/swagger-it/releases/latest)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n\n# swagger-it\n\u003e Automatically generate swagger.io yaml file from your project.\nyaml file.\n\nThis turn your workflow around by code first then generate an update to date\nAPI documentation.\n\n\n\u003c!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc --\u003e\n**Table of Contents**\n\n- [swagger-it](#swagger-it)\n    - [Command Line](#command-line)\n        - [Example Usage](#example-usage)\n    - [Installation](#installation)\n    - [Dependencies](#dependencies)\n    - [Supported Languages](#supported-languages)\n    - [Todo List](#todo-list)\n    - [References](#references)\n\n\u003c!-- markdown-toc end --\u003e\n\n\n## Command Line\n\nFull command line design.\n\n```\nusage: swagger-it.py [-h] [--input INPUT] [--output OUTPUT] [--version]\n\nswagger-it: Parse your microservice project into a swagger yaml file. (Version 0.0.1)\n\noptional arguments:\n  -h, --help            show this help message and exit\n  --input INPUT, -i INPUT\n                        Input path, this can be a directory or file.\n  --output OUTPUT, -o OUTPUT\n                        Output path, this must be a path point to a file.\n  --version             Display version information and dependencies.\n```\n\n### Example Usage\n\nParameters `-i` and `-o` are must variables for now.\n\n**[INFO] I am currently working on the parsing comment/docstring.**\n\n```\npython -i './' -o './output/file.yml'\n```\n\n## Installation\n\n**NOTE**: Python 3.6 or higher is required.\n\n```bash\n# clone the repo\n$ git clone https://github.com/jcs-workspace/swagger-it.git\n\n# change the working directory to sherlock\n$ cd sherlock\n\n# install python3 and python3-pip if they are not installed\n\n# install the requirements\npython3 -m pip install -r requirements.txt\n```\n\n## Dependencies\n\nThis is a list of dependencies, make sure you installed all these from \n[pip](https://pypi.org/project/pip/)\ncorrectly!\n\n* [argparse](https://pypi.org/project/argparse/)\n* [python-magic-bin](https://pypi.org/project/python-magic-bin/)\n* [python-magic](https://pypi.org/project/python-magic/)\n* [libmagic](https://pypi.org/project/libmagic/)\n* [comment_parser](https://pypi.org/project/comment-parser/)\n\n## Supported Languages\n\n* C\n* C++\n* Objective-C\n* C#\n* JavaScript\n* Java\n* Python\n* Go\n* Ruby\n\n## Todo List\n\n- [ ] Implementes core changes to generate yaml file.\n- [ ] Design the template file. (Make it as extensible as possible)\n- [ ] Design the tags and docstring to work together.\n\n## References\n\n* https://github.com/swaggo/swag\n* https://editor.swagger.io/?_ga=2.130550666.406048183.1579233982-1663214344.1579233982\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcs090218%2Fswagger-it","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjcs090218%2Fswagger-it","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcs090218%2Fswagger-it/lists"}