https://github.com/jcs090218/swagger-it

Automatically generate the swagger.io yaml file for your project.
https://github.com/jcs090218/swagger-it

annotations api automation documentation openapi swagger

Last synced: about 1 month ago
JSON representation

Automatically generate the swagger.io yaml file for your project.

• Host: GitHub
• URL: https://github.com/jcs090218/swagger-it
• Owner: jcs090218
• License: mit
• Created: 2020-01-17T08:18:50.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-07T10:56:54.000Z (almost 5 years ago)
• Last Synced: 2024-10-26T09:52:15.663Z (3 months ago)
• Topics: annotations, api, automation, documentation, openapi, swagger
• Language: Python
• Homepage:
• Size: 79.1 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.com/jcs-workspace/swagger-it.svg?branch=master)](https://travis-ci.com/jcs-workspace/swagger-it)

[![Unity Engine](https://img.shields.io/badge/python-%3E=_3.6-green.svg)](https://www.python.org/downloads/)

[![Release Tag](https://img.shields.io/github/tag/jcs-workspace/swagger-it.svg?label=release)](https://github.com/jcs-workspace/swagger-it/releases/latest)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

# swagger-it

> Automatically generate swagger.io yaml file from your project.

yaml file.

This turn your workflow around by code first then generate an update to date

API documentation.

**Table of Contents**

- [swagger-it](#swagger-it)

    - [Command Line](#command-line)

        - [Example Usage](#example-usage)

    - [Installation](#installation)

    - [Dependencies](#dependencies)

    - [Supported Languages](#supported-languages)

    - [Todo List](#todo-list)

    - [References](#references)

## Command Line

Full command line design.

```

usage: swagger-it.py [-h] [--input INPUT] [--output OUTPUT] [--version]

swagger-it: Parse your microservice project into a swagger yaml file. (Version 0.0.1)

optional arguments:

  -h, --help            show this help message and exit

  --input INPUT, -i INPUT

                        Input path, this can be a directory or file.

  --output OUTPUT, -o OUTPUT

                        Output path, this must be a path point to a file.

  --version             Display version information and dependencies.

```

### Example Usage

Parameters `-i` and `-o` are must variables for now.

**[INFO] I am currently working on the parsing comment/docstring.**

```

python -i './' -o './output/file.yml'

```

## Installation

**NOTE**: Python 3.6 or higher is required.

```bash

# clone the repo

$ git clone https://github.com/jcs-workspace/swagger-it.git

# change the working directory to sherlock

$ cd sherlock

# install python3 and python3-pip if they are not installed

# install the requirements

python3 -m pip install -r requirements.txt

```

## Dependencies

This is a list of dependencies, make sure you installed all these from 

[pip](https://pypi.org/project/pip/)

correctly!

* [argparse](https://pypi.org/project/argparse/)

* [python-magic-bin](https://pypi.org/project/python-magic-bin/)

* [python-magic](https://pypi.org/project/python-magic/)

* [libmagic](https://pypi.org/project/libmagic/)

* [comment_parser](https://pypi.org/project/comment-parser/)

## Supported Languages

* C

* C++

* Objective-C

* C#

* JavaScript

* Java

* Python

* Go

* Ruby

## Todo List

- [ ] Implementes core changes to generate yaml file.

- [ ] Design the template file. (Make it as extensible as possible)

- [ ] Design the tags and docstring to work together.

## References

* https://github.com/swaggo/swag

* https://editor.swagger.io/?_ga=2.130550666.406048183.1579233982-1663214344.1579233982