Skip to content
This repository has been archived by the owner on Mar 26, 2024. It is now read-only.

katoquro/apiator

Repository files navigation

Logo

Build Status Artifact Version Gradle plugin

What is Apiator

Apiator is a tool for creating API description automatically from annotation based web frameworks and javadoc. The major idea is to take as much as possible from source code and override where it is needed with powerful configuration.

Currently supported frameworks are:

Build Status

Getting started

Apiator is available as a Gradle Plugin.

Another way to use is programmatic configuration. In *SmokeSpec.groovy test you can find examples for different providers and renderers.

All starting steps and many more can be found at Doc Site.

We are looking for help

  • JavaScript developers to evolve html-renderer issues.
  • Go lang developers to create standalone hosting to analyze, archive and preview API changes. More information about Apiator Hangar
  • Java/Groovy developers to extend core functionality.

If you have found a bug, want to suggest feature or documentation update please create corresponding issue. Or make a pool request with your changes!