npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

java-to-openapi

v1.0.4

Published

A CLI tool to convert Java classes to OpenAPI 3 YAML.

Downloads

7

Readme

Java-to-OpenAPI

Java-to-OpenAPI is a command-line interface (CLI) tool that converts Java classes into OpenAPI 3 specifications in YAML format. This tool is useful for developers who want to automatically generate OpenAPI documentation from Java classes.

Installation

You can use java-to-openapi directly with npx, without the need for prior installation:

npx java-to-openapi <source-directory> <output-file>

Usage

Basic Command

To use the tool, run the command:

npx java-to-openapi <source-directory> <output-file>
  • <source-directory>: The path to the directory containing the .java files.
  • <output-file>: The path and name of the output YAML file.

Example

If you have a src/example folder with your Java classes and want to generate an api-spec.yaml file in the project root, run:

npx java-to-openapi ./src/example ./api-spec.yaml

File Structure

src/
└── example/
    ├── Produto.java
    └── Categoria.java

Features

  • Java Class Conversion: Analyzes Java classes and automatically generates the corresponding OpenAPI 3 specification.
  • Primitive Type Support: Converts common Java types (int, String, boolean, etc.) to their OpenAPI equivalents.
  • List Support: Identifies and converts lists (List) to arrays in OpenAPI.
  • Recursiveness: Processes .java files in subdirectories recursively.

Supported Class Examples

The tool supports both simple and complex classes, including those containing lists or references to other classes.

Example Java Class:

import java.util.List;

public class Produto {
    private int id;
    private String nome;
    private double preco;
    private boolean emEstoque;
    private Categoria categoria;
    private List<String> tags;
    private List<Categoria> categoriasRelacionadas;

    // Getters and Setters omitted for brevity
}

YAML Output:

openapi: 3.0.0
info:
  title: API Documentation
  version: 1.0.0
components:
  schemas:
    Produto:
      type: object
      properties:
        id:
          type: integer
        nome:
          type: string
        preco:
          type: number
        emEstoque:
          type: boolean
        categoria:
          $ref: '#/components/schemas/Categoria'
        tags:
          type: array
          items:
            type: string
        categoriasRelacionadas:
          type: array
          items:
            $ref: '#/components/schemas/Categoria'
    Categoria:
      type: object
      properties:
        id:
          type: integer
        nome:
          type: string

Contributing

If you find any bugs or have suggestions for improvements, feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Author

Developed by Gabriell Huver.