ballerinax/readme Ballerina library

1.5.1

Overview

This is a generated connector for Readme API v2.0 OpenAPI specification.
The Readme API provides the capability to create product and API documentation programmatically.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

  1. Create a Readme account.
  2. Obtain tokens - Follow this guide.

Quickstart

To use the Readme connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/readme module into the Ballerina project.

Copy
import ballerinax/readme;

Step 2: Create a new connector instance

You can now make the connection configuration using the Readme API keys config.

Copy
http:CredentialsConfig & readonly authConfig = ?;
readme:ClientConfig clientConfig = {auth : authConfig};
readme:Client readmeClient = check new (clientConfig);

Step 3: Invoke connector operation

Following is code demonstrates how to get a project using ballerinax/readme connector.

Copy
public function main() returns error? {
    http:Response entity = check readmeClient->getProject();
}

Import

import ballerinax/readme;Copy

Metadata

Released date: 10 months ago

Version: 1.5.1

License: Apache-2.0


Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes


Pull count

Total: 

Current verison: 2


Weekly downloads


Source repository


Keywords

Content & Files/Documents
Cost/Freemium

Contributors

Other versions

See more...