This documentation is for WSO2 API Manager 2.1.0. View documentation for the latest release.

All docs This doc

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. Write a custom indexer.
    The following is the sample indexer code.

    Code Block
    package org.wso2.indexing.sample;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    import java.util.Arrays;
    import org.apache.solr.common.SolrException;
    import org.wso2.carbon.registry.core.exceptions.RegistryException;
    import org.wso2.carbon.registry.core.utils.RegistryUtils;
    import org.wso2.carbon.registry.indexing.IndexingConstants;
    import org.wso2.carbon.registry.indexing.AsyncIndexer.File2Index;
    import org.wso2.carbon.registry.indexing.indexer.Indexer;
    import org.wso2.carbon.registry.indexing.solr.IndexDocument;
    public class PlainTextIndexer implements Indexer {
        public IndexDocument getIndexedDocument(File2Index fileData) throws SolrException,
                RegistryException {
                 /* Create index document with resource path and raw content*/
                 IndexDocument indexDoc = new IndexDocument(fileData.path, RegistryUtils.decodeBytes(, null);
                 /* You can specify required field/value pairs for this indexing document.
                  * When searching we can query on these fields  */
                 Map<String, List<String>> fields = new HashMap<String, List<String>>();
                 fields.put("path", Arrays.asList(fileData.path));
                 if (fileData.mediaType != null) {
                             fields.put(IndexingConstants.FIELD_MEDIA_TYPE, Arrays.asList(fileData.mediaType));
                 } else {
                             fields.put(IndexingConstants.FIELD_MEDIA_TYPE, Arrays.asList("text/plain"));
                 /* set fields for index document*/
                 return indexDoc;
  2. Add the custom indexer JAR file to the <APIM<API-M_HOME>/repository/components/lib directory.

  3. Update the <Indexers> element in the <APIM<API-M_HOME>/repository/conf/registry.xml file with the new indexer.
    The content is indexed using this media type. For example,

    Code Block
         <indexer class="org.wso2.indexing.sample.PlainTextIndexer" mediaTypeRegEx="text/plain" profiles="default,api-store,api-publisher"/>

    The attributes of the above configuration are described below:

    classJava class name of the indexer.
    mefiaTypeRegExA regular expression (regex) pattern to match the media type.
    profilesAPIM API-M profiles in which the indexer is available.
  4. Restart the server.
  5. Add the API documentation using the new media type and then thereafter search some term in the documentation using the syntax (doc:keyword).
    You will can now see how the documentation has got indexed according to the media type.