Skip to main content

Introduction

Now that you have defined the table structure, operations, and added data, Rocket automatically generates APIs for your database based on all the tables, attributes within those tables, and the operations specified on those attributes. Additionally, Rocket generates basic documentation for these APIs, derived from the details provided during database, table, and attribute creation.

While Rocket generates basic documentation, it is essential to review and enhance the documentation on the APIs page to improve comprehension and foster better collaboration.

API Operations​

  • Documenting APIs: Refer to the documentation on documenting APIs to understand the process for documenting APIs effectively.
  • Swagger and Redoc: Explore the documentation on Swagger and Redoc to learn more about these tools and how to utilize them efficiently.

Field Rules​

The following table outlines the field rules for documenting apis:

FieldDescriptionData TypeMinimum LengthMaximum LengthValid OptionsDefault ValueIs OptionalExtra Details
TitleAPI Titlestring225--No-
DescriptionAPI Descriptionlarge-text2255--No-