Edit an API from the Source Code

Most common API configurations are facilitated through the API Publisher. You log in to the Publisher and click the Edit link next to the API's name to edit it using the UI. The Edit link is visible only to users with creator privileges.

To do more advanced configurations, you can go to the API's code-level using the management console as follows, or you can directly edit the file saved in <APIM_HOME>/repository/deployment/server/synapse-configs/default/api.

1. Log in to the management console (https://localhost:9443/carbon) using admin/admin credentials.

2. Select Source View sub menu under the Service Bus menu.
   

3. Source view contains the configuration of the API Gateway. You find sequences, filters, properties, APIs etc. defined there. Search for the name of the API you want, and edit its content wrapped by the <api></api> elements.

   You should not remove the default filter mediator and handler configurations in your API. They are needed for routing requests based on the throttling/security policies. If you want to add a custom mediator in the insequence path of a request, add that inside the filter mediator configuration as shown in the following example.

   <filter source="$ctx:AM_KEY_TYPE" regex="PRODUCTION">
      <then>
         <class name="org.wso2.carbon.custommediator.CustomDataMediator"/>
         ........................
      </then>
   </filter>

4. Click Update to save your changes.
   

5. Alternatively, you can also select the APIs sub menu under the Service Bus menu. This allows you to isolate and edit a specific API rather than viewing the entire source code.
   
6. The Deployed APIs page opens. From there, you can select an API and click the Edit link associated with it.
7. The Edit API page opens. You can switch to its source view to edit its configuration code.
   

   

8. After editing the file, save and restart the server.