{"id":14756,"date":"2023-11-28T00:38:03","date_gmt":"2023-11-28T08:38:03","guid":{"rendered":"https:\/\/www.pingcap.com\/?p=14756"},"modified":"2025-08-18T03:01:18","modified_gmt":"2025-08-18T10:01:18","slug":"backend-management-csv-rest-api-tidb-cloud-data-service","status":"publish","type":"post","link":"https:\/\/www.pingcap.com\/ko\/blog\/backend-management-csv-rest-api-tidb-cloud-data-service\/","title":{"rendered":"Effortlessly Transform CSV into a REST API with TiDB Cloud Data Services\u00a0"},"content":{"rendered":"

Efficient backend management is a cornerstone of successful application development. Navigating this realm poses significant challenges, especially when aligning with emerging backend trends. This often leads to time-consuming and repetitive architectural processes.<\/p>\n\n\n\n

To solve this challenge, we introduce TiDB Serverless and TiDB Cloud Data Service (TCDS) \u2014remarkable product offerings of TiDB Cloud.<\/p>\n\n\n\n

TiDB Serverless<\/a> is a fully managed, autoscaling Database-as-a-Service (DBaaS) solution built on TiDB, an advanced open-source, distributed SQL database. TiDB Serverless introduces a dynamic and cost-effective approach to data management, eliminating the complexities of upfront sizing, resource rebalancing, and idle assets. Meanwhile, TCDS, an integral part of TiDB Cloud, bridges the gap between database functionalities and comprehensive backend management, offering a low-code, fully managed backend-as-a-service solution.<\/p>\n\n\n\n

We refer you to our previous post<\/a> for an in-depth understanding of TCDS and its benefits. In this article, our focus shifts to demonstrating the practical applications of these services. We’ll guide you through the seamless process of transforming a standard CSV file into a fully functional RESTful API, leveraging the capabilities of TCDS.<\/p>\n\n\n\n

<\/span>Set up a TiDB Serverless Cluster<\/span><\/h2>\n\n\n\n

Take the steps below to create a free TiDB Serverless cluster: <\/p>\n\n\n\n

    \n
  1. Sign in<\/a> to your TiDB Cloud. Register a TiDB Cloud<\/a> account if you haven\u2019t got one.<\/li>\n\n\n\n
  2. Follow the on-screen instructions to create a free Serverless Tier cluster within seconds.
    <\/figure><\/li>\n<\/ol>\n\n\n\n

    <\/span>Import a CSV File <\/span><\/h2>\n\n\n\n

    For this guide, we have provided a CSV spreadsheet<\/a> that contains sample employee data. <\/p>\n\n\n\n

      \n
    1. Download the sample employee data CSV file provided for this guide.<\/li>\n\n\n\n
    2. In the TiDB Cloud console, click the TiDB Serverless cluster name to access the cluster overview page. Select Import <\/strong>from the left navigation menu and upload the previously downloaded .csv file.
      \"\"<\/figure><\/li>\n\n\n\n
    3. In the Target<\/strong> section, specify the database as test<\/code> and enter employees<\/code> as the table name.
      \"\"<\/figure><\/li>\n\n\n\n
    4. Click the \uc2dc\uc0ac<\/strong> button to review the metadata information extracted from the uploaded .csv file. Mark the empid<\/code> column as the Primary Key by selecting<\/em> the checkbox.
      \"\"<\/figure><\/li>\n\n\n\n
    5. Click the Start Import<\/strong> button to initiate the import process. This creates the employees<\/em> table within the test<\/em> database, populating it with the 3000 records as sourced from the .csv file. This process should only take a few seconds.<\/li>\n<\/ol>\n\n\n\n

      <\/span>Create a Data App<\/span><\/h2>\n\n\n\n

      Assuming the data import process is successful, the next step is to create a Data App, which serves as the initial phase for generating REST Endpoints. Data App is a container that consists of a collection of objects like Endpoints. Please refer to our documentation<\/a> for comprehensive details on managing a Data App.<\/p>\n\n\n\n

        \n
      1. To create a Data App, simply click the Data Service<\/strong> icon and then click the Create Data App<\/strong> button.
        \"\"<\/figure><\/li>\n\n\n\n
      2. In the Create Data App<\/strong> screen, enter Employee Management<\/em> for the Data App Name<\/strong> field, and select the containing cluster (in our case, Cluster0) for Link Data Sources. Then, click the Create<\/strong> button.
        \"\"<\/figure><\/li>\n<\/ol>\n\n\n\n

        <\/span>Create Endpoints<\/span><\/h2>\n\n\n\n

        Congratulations on successfully creating your first Data App! Now, let’s proceed to create endpoints for the employee<\/code> table.  <\/p>\n\n\n\n

          \n
        1. On the left navigation bar, find your Data App name, click the “+” symbol next to it, and select the Autogenerate Endpoint option that pops up.
          \"\"<\/figure><\/li>\n\n\n\n
        2. Configure Endpoint settings as specified in the image below:
          \"\"<\/figure><\/li>\n\n\n\n
        3. Enable the Auto-Deploy Endpoint <\/strong>option for immediate deployment.<\/li>\n\n\n\n
        4. Click the Generate<\/strong> button to generate and deploy the configured endpoint automatically. <\/li>\n<\/ol>\n\n\n\n

          Within a matter of seconds, you’ll see your endpoints created and deployed, ready for you to explore and manipulate the employees<\/code> data.<\/p>\n\n\n\n

          \"\"<\/figure>\n\n\n\n

          <\/span>Create API Key<\/span><\/h2>\n\n\n\n

          Before you start exploring your new endpoints, you’ll need to set up an API Key for secure authentication. Here’s how to create one:<\/p>\n\n\n\n

            \n
          1. Navigate to your Data App’s main page by clicking Employee Management<\/strong>. <\/li>\n\n\n\n
          2. Inside the Settings<\/strong> menu, find the authentication section and click the Create API Key<\/strong> button.
            \"\"<\/figure><\/li>\n\n\n\n
          3. In the Create API Key<\/strong> popup screen, specify the following: