Development

Product Specifics / Service Guide Template

This chapter details the tasks and procedures that are relevant for the application developer when adjusting the application itself in order to enable it to consume the service. This information might be provided within one or multiple topics. Create/migrate all your tutorials in the Tutorial Navigator and link them from here.

<div> <div></div> <div></div> </div> <div> <div><strong>Target group</strong></div> <div>Application developer</div> </div> <div> <div><strong>Mandatory / Optional</strong></div> <div>Optional</div> </div> <div> <div><strong>Size</strong></div> <div>Multiple topics possible (grouped under root topic )</div> </div>

Basic Considerations

You are now addressing the application developer who wants to reuse ("consume") functionality that is provided by the service. The developer knows already from the previous chapters what the service has to offer and how it is set up.

Now he or she wants to come straight to the point and needs basically the interface documentation that describes

how a certain functionality of the service can be called.
which request parameters needs to be passed to the service.
how the expected response from the service looks like.
what possible error situations are and how these are communicated by the service.

The following questions might help you when collecting information for this chapter:

Is there documentation in the API Business Hub that you can link to?
Normally, this documentation on API Business Hub contains all information mentioned above, including access to a test bed environment.
Does the API reference documentation on API Business Hub provide sufficient information for working with the APIs?
Refer to this documentation and put an external link to API Business Hub into the topic.
If the information is not sufficient, provide only additional information in the service guide that complements the API reference documentation and explains how to use the API.
Do not repeat what has already been described in the API Business Hub.
To minimize the coding effort and simplify the implementation for application developers, sometimes a (convenience) library is provided by the service that encapsulates the service's API.
Does the service provide a library?
Is there library documentation that you can link to?
If it is a Java library, your developers are able to generate sufficient documentation from the Java source code using Javadoc.
Upload the Javadoc file that has been provided to you by development to Help Portal and put an external link to it into the topic.
Does the library documentation provide sufficient information for working with the APIs, or do you need to provide more information in the service guide?
Only if the information is not sufficient, provide more information in the service guide.
Even if there's a library available, it is still useful to also link to the API Hub.
The service developers might have created a demo application for their own reference that they use to show and explain how an application can consume the service.
Is there a reference application that you can link to or that can be downloaded from a test drive or that can easily be set up?
Can you provide code samples (for example, from that demo application)?
If there is no appropriate content that you can link to, you have to describe the interface yourself.
Refer to Manually Written REST and OData API Reference in the S&G for API Documentation to manually document REST and OData APIs using the dedicated templates in the DITA CMS.

Topic Content

Title: Development

Use "Development" as the title of your topic. Do not replace it with another title.

information

In the previously announced version of this template, the section title was "Developing Applications Using the Service". If this is the case with your service guide, please update the section title.

Sub-title: Tutorials

Link to all tutorials in the Tutorial Navigator. Use a bulleted list or a table (in case you would like to group the tutorials).

Sub-title: Multitenancy Support

If your service is multitenancy enabled, add the details specific to your service.

Depending on the environment, add the following text and links:

To subscribe to multitenant application from the Subscriptions page in the SAP BTP cockpit, see: