API Documentation now available for all editions of SugarCRM

bsoremsugar —  November 15, 2011 — 8 Comments

One of the biggest pieces of feedback we’ve got is the lack of API documentation for Sugar, which has made it tricky for people to navigate thru our API and know what methods are available. We are kicking off a project to fix this, where in the process we will be going thru our entire API, top to bottom, cleaning it up and deprecating items along the way in an effort to make it much easier to customize and build add-ons to SugarCRM. You’ll start seeing pieces of this effort coming in 6.4, with the refactoring of the database layer, and it will be expanding to much of the other core code going forward. As always, stay tuned to this blog for insight into this effort.

The first step of this process for us was giving everyone a way to visualize what our API currently looks like. We turned to the PHP Community for a tool for this purpose, and found the DocBlox project lead by Mike van Riel. He helped us get started with using DocBlox, and then we were able to quickly get it integrated into our CI and build processes to generate nice looking API documentation for all editions of Sugar. And we are publishing these for all our developer community to use; you can view them right in the same area as our other documentation.

Let us know if this helps everyone out, as well as any other feedback on our API definition project.

8 responses to API Documentation now available for all editions of SugarCRM

  1. 

    Good idea. Most things work good, but there are some bugs at the moment and for some things their usage is unclear to me (Reports?). It would be nice to have some kind of help for the usage of the documentation itself.

    I tried it with the documentation for CE 6.3.0 and got the following problems:

    It was not possible to view the charts diagram.
         – Firefox 7.0.1 shows a message that a plugin has to be installed. When I click on “install plugin” I get another message that there is no such plugin available … Since there is no message what kind of plugin is needed I have no chance to look for my own.
         – Google Chrome (actual release 15.0.874.120 m) shows pure code, but no diagram.
     
    Internet Explorer 8 wants to install something (‘ce’, 1005 Bytes) from apidocs.sugarcrm.com before showing almost anything when using this url: http://apidocs.sugarcrm.com/6.3.0/ce/.

    • 

      We will take a look at this. Thanks for letting us know.

    • 

      This should be fixed now. The diagram is an SVG image, so if your browser doesn’t have the compatibility it will not show.

      • 

        Thanks John. The chart is visible now (tested with Firefox 7.0.1). It is nice to navigate to a class by clicking on the classes name in the chart. And I like the idea of giving a graphical overview of Sugar and its classes.

        Unfortunately the chart is so big that it does not give an overview of the system as it should do. I never before saw my browser with three (!) vertical scroll bars and it needs to use at least two of them to get to the bottom of the chart.
        In my opinion it is not such a good idea to put all together in one big chart, because it is complete useless as it is at the moment. I think it would be much better to split the chart into several sub-charts …

  2. 

    Cant see the use of this at all, but I gues it looks nice and techy

  3. 

    Great concept… Can you add actual use cases.  How about explaining how it works together? What has changed from one version to the next (this would be great!)

    • 

      The main use case is to have a searchable API guide to using Sugar. Most applications, platforms, and frameworks provide this, which is a great guide for developers who are actively developing on the platform, saving them from the need to grep thru the source code.

      Going forward, we are definitely in the process of using this to document a true API ( starting in the 6.4.0 release ), and then putting together a much better, multileveled developer guide. Keep your eyes open for this coming down the pipe in the coming months.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s