piggypiglet / docdex

JSON API & Discord Bot for Javadocs

Warning! This software is in beta, it is extremely likely there'll be bugs, and some ugly things. Please report bugs, and make suggestions via the issues tab.

Documentation Index (DocDex) is a utility API which scans javadocs on the web, caches everything into a mixture of memory, file, and database, then provides a JSON API to easily (and quickly!) access the information.

Documentation

• API
  • Routes
    • Index Route
    • Javadocs Route
  • Object Structure
  • Population
    • Web Crawling
  • Running
  • Commands
• Discord
  • Invite
  • Public Instance
  • Commands
  • Running
• Development
• Quick Links
  • Bot Invite
  • Jenkins
  • Discord Server/Support

Support

Tag me in the HelpChat discord, or my personal discord.

Endorsements

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.