https://github.com/shivamka1/jaxrs-json-api-docs

A Java library to generate API documentation in JSON format for JAX-RS annotated classes.
https://github.com/shivamka1/jaxrs-json-api-docs

Last synced: about 8 hours ago
JSON representation

A Java library to generate API documentation in JSON format for JAX-RS annotated classes.

• Host: GitHub
• URL: https://github.com/shivamka1/jaxrs-json-api-docs
• Owner: shivamka1
• License: mit
• Created: 2016-09-22T11:50:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-11-13T18:06:04.000Z (about 8 years ago)
• Last Synced: 2025-01-13T06:20:57.770Z (6 days ago)
• Language: Java
• Size: 8.79 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jaxrs-json-apidocs

A Java library to generate API documentation in JSON format for JAX-RS annotated classes.

**Sample Input**

``` java

@Path("/messenger")

public interface MessageResourceI {

	

	@GET

	@Path("/messages")

	@Produces("application/json")

	public Response getMessages(@QueryParam("messageId") int messageId);

}

```

**Sample Output**

```

{

    "resources": [{

        "path": "/messenger/messages",

        "requests": [{

            "verb": "javax.ws.rs.GET",

            "produces": ["application/json"],

            "parameters": [{

                "title": "messageId",

                "type": "int"

            }]

        }]

    }]

}

```




> It currently is capable of parsing only limited JAX-RS annotations. Also, API documentation design is still under consideration.