Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 2.18 KB

README.md

File metadata and controls

72 lines (47 loc) · 2.18 KB
Raw

Go Client for the ReadMe.com API

Version GoDoc

📖 Refer to https://pkg.go.dev/github.com/liveoaklabs/readme-api-go-client for the Go package documentation.

☁️ Also see our Terraform provider for ReadMe that uses this library.

This library is developed by Live Oak Bank and is not officially associated with ReadMe.com.

Getting Started

Import the package and call the readme.NewClient() function with a token provided to set up the API client.

package main

import "github.com/liveoaklabs/readme-api-go-client/readme"

const readmeAPIKey string = "rdme_xxxxxxxx..."

func main() {
  client, err := readme.NewClient(readmeAPIKey)
  if err != nil {
    log.Fatal(err)
  }
}

Examples

Using the APISpecification.GetAll() method to retrieve all API specifications for a project on ReadMe.com:

specs, _, err := client.APISpecifications.GetAll()
if err != nil {
    log.Fatal("Error getting API specifications: ", err)
}

if specs == nil {
    log.Fatal("No results.")
}

Disclaimer About Versioning and Development Status

⚠️ This project is currently under active development and is versioned using the 0.x.x scheme.

Breaking changes will likely occur and will trigger a minor version increment (e.g., 0.2.0->0.3.0).

Users are encouraged to pin the package to a specific patch version for maximum stability throughout the 0.x.x series.

A stable 1.x release is planned for the future once the project meets certain criteria for feature completeness and stability.

Refer to the CHANGELOG for release details.

Contributing

Refer to CONTRIBUTING.md for information on contributing to this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.