API Addition Request beta

Publishing on gotAPI is easy and includes two simple steps.
You would need to:
  1. Create XML file outlining structure of help content
  2. Send us the file and information about the content

Two things to remember before you proceed:
  • gotAPI.com does not host help contents. Instead it stores searchable index of the help content. We will not be able to provide hosting for help pages, JavaDocs or similar content.
  • gotAPI does not validate integrity of the links. You are fully responsible for URL validation and making sure that content is appropriate.

Creating Content Structure XML File

gotAPI content tree is described in a simple XML file containing nested elements matching corresponded nodes of the content tree. For example for following tree strcutre:
class DOMStringList
   - length
   - contains(...)
class NameList
   - length
   - getName(...)
You would need to create XML file similar to this:
<pages>
    <page title="DOMStringList" type="class" url="http://www.w3...core.html#DOMStringList">
        <page title="length" type="property" url="http://www.w3...core.html#DOMStringList-length"/>
          <page title="contains" type="method" url="http://www.w3...core.html#DOMStringList-contains"/>
       </page>
    <page title="NameList" type="class" url="http://www.w3...core.html#NameList">
        <page title="length" type="property" url="http://www.w3...core.html#NameList-length"/>
          <page title="getName" type="method" url="http://www.w3...core.html#NameList-getName"/>
       </page>
</pages>
Every 'page' element of the XML file corresponds to node in the content tree. It could have any number of nested page elements. XML element 'page' supports following attributes:
  • title - (required) title of the tree node. Will be used in as-you-type search
  • type - (required) - type of the notion described by the page. Could be one of the following: document | package | class | method | tag | property | style | value. This value at the moment does not carry any semantical value and only affect presentation of the node in the tree. Example: type='method'
  • url - (required) URL of the content.
You can also verify your XML against pages-schema.xsd to make sure it is valid.

Publishing Terms

Before you submit information please read the following publishing terms. You will need to accept them to request addition to gotAPI service.
  • gotAPI assumes no responsible for validating content integrity and relevancy of the links provided in the index file.
  • gotAPI does not guarantee the fact or timeline of adding APIs to the gotAPI website
  • gotAPI reserves a right to remove references at any time without notice
  • provider of API index is responsible for making sure that added content does not violate content or technology copyrights

Submit API

To submit a request please prepare XML file and submit it with the form provided below:
Index Information
Reference Title:
E.g: W3Consortium DOM Level 3
Tab Title:
E.g: DOM v3
 Future title of the tab on gotAPI.com. Tab title should be concise and limited to 17 characters.
Upload index file: Please provide XML file. File structure is defined here.
Content Origin
Original URL:
E.g: http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/Overview.html
 Full path to the home page of the original reference
Original Content Provider:
E.g: W3 Consortium
 Organizaiton/person created the original content.
Contact Information
Your Name / Company:
E.g: 'John Smith' or 'Web20 Association'
 This information will be displayed on gotAPI website
Your Email:
E.g: John.Smith@hostname.com
 gotAPI will not publish or share your email address with other parties
Terms and Conditions
I accept publishing terms and conditions listed above.