> For the complete documentation index, see [llms.txt](https://docs.opshub.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opshub.com/v7.226/connector-sdk-index/getting-started/sdk-best-practices.md).

# SDK Best Practices

* When dealing with REST APIs in the end system, try to map the request and response JSON to programming objects rather than dealing with maps or dictionaries.
  * For example, when implementing APIs in Java, convert JSON payloads to Java classes.
    * Following are the links that can help you convert JSON to Java classes:
      * <https://jsonformatter.org/json-to-java>
      * <https://www.baeldung.com/java-generate-class-from-json>
* The required static response for [Entity Type – Get](/v7.226/connector-sdk-index/sdk-connector-apis/entity-type-get.md) or [Connector Metadata – Get](/v7.226/connector-sdk-index/sdk-connector-apis/connector-metadata-get.md) APIs can be stored in JSON format. Additionally, JSON can be converted to programming objects for adding dynamic fields to the response.
  * Therefore, it will be easier to prepare a JSON file instead of preparing the objects.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.opshub.com/v7.226/connector-sdk-index/getting-started/sdk-best-practices.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.