Giter Club home page Giter Club logo

javalin-openapi-apt's Introduction

javalin-openapi-apt

Annotation processing to generate OpenAPI specification from source code using Javalin.

This annotation processor uses JavaParser to analyze the way a project uses Javalin and to generate a corresponding OpenAPI v3 document. It can derive the paths (including path parameters), query parameters, request body and the response body (with the appropiate schema). Some significant limitations apply (see Limitations section below). This project is a proof of concept, so usage in production is not recommended.

Limitations

  • The processor only works with javac.
  • The ApiBuilder of Javalin must be used to construct the paths. Only a single method for the full routing tree is supported.
  • Handlers must be passed as method references to the ApiBuilder methods.
  • Polymorphic models will only have their base class in the resulting OpenAPI document.
  • Required property of parameters or fields on a model are not supported.
  • Handlers that conditionally respond with different types of bodies or requires different paremeters aren't supported.

The processor tries to gracefully handle unsupported constructions by producing a descriptive error.

javalin-openapi-apt's People

Contributors

mrxz avatar

Watchers

 avatar  avatar

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.