Giter VIP home page Giter VIP logo

oe-swagger-generator's Introduction

oe-swagger-generator

OpenEdge API - Swagger Document Generator

This repository contains a Swagger Document Generator Plug-in for using on OpenEdge ABL projects.

Automation for Documentation of APIs using Swagger

The Swagger parser read a external YAML file and get the procedures number and methods number for validate with a PROGRESS file.

YAML file example

swagger: "2.0"
info:
  description: "This is a sample for YAML file"
  version: "1.0.0"
  title: "Sample API Totvs-REST"
  program: programName.p
basePath: "/tstUn/v1/"
program: programName.p
...   
paths:
  /tstUniApiDatasul:
    get:
      procedure: pi-get
    ...

The tag basePath contains where the PROGRESS file is. And the tag program have the name of PROGRESS file to read.

PROGRESS file example

...
PROCEDURE pi-get:
    DEF INPUT  PARAM jsonInput  AS JsonObject NO-UNDO.
    DEF OUTPUT PARAM jsonOutput AS JsonObject NO-UNDO.
    
    ASSIGN jsonOutput = jsonInput.
END.
...

So the YAML file need have the same number of procedures and methods, for then comparing with PROGRESS file. The comparing with PROGRESS file is based with the numbers of procedures and methods find in the YAML file and find in the PROGRESS file. When the comparing is True the YAML file is convert to JSON file.

oe-swagger-generator's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.