https://github.com/magodo/terraform-provider-restful

Terraform provider to manage RESTful resources
https://github.com/magodo/terraform-provider-restful

terraform terraform-provider

Last synced: 2 days ago
JSON representation

Terraform provider to manage RESTful resources

• Host: GitHub
• URL: https://github.com/magodo/terraform-provider-restful
• Owner: magodo
• License: mpl-2.0
• Created: 2022-04-20T13:01:44.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-19T03:10:35.000Z (about 2 months ago)
• Last Synced: 2024-08-19T04:27:09.314Z (about 2 months ago)
• Topics: terraform, terraform-provider
• Language: Go
• Homepage: https://registry.terraform.io/providers/magodo/restful
• Size: 489 KB
• Stars: 14
• Watchers: 4
• Forks: 5
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Terraform Provider Restful

This is a general Terraform provider aims to work for any platform as long as it exposes a RESTful API.

The document of this provider is available on [Terraform Provider Registry](https://registry.terraform.io/providers/magodo/restful/latest/docs).

## Features

- Different authentication choices: HTTP auth (basic, token), API Key auth and OAuth2 (client credential, password credential, refresh token).

- Customized CRUD methods and paths

- Support precheck conditions

- Support polling asynchronous operations

- Partial `body` tracking: only the specified properties of the resource in the `body` attribute is tracked for diffs

- `restful_operation` resource that supports arbitrary Restful API call (e.g. `POST`) on create/update

## Why

Given there already exists platform oriented, first-class providers, why do I create this? The reason is that most providers today are manually maintained, which means some latest features are likely not available in these first-class providers. For this case, `terraform-provider-restful` can be used as your escape hatch.

Another common use case is that the platform you are currently working on do not have a Terraform provider yet. In this case, you can use `terraform-provider-restful` to manage the resources for that platform.

## Requirement

`terraform-provider-restful` has following assumptions about the API:

- The API is expected to support the following HTTP methods:

    - `POST`/`PUT`: create the resource

    - `GET`: read the resource

    - `PUT`/`PATCH`/`POST`: update the resource

    - `DELETE`: remove the resource

- The API content type is `application/json`

- The resource should have a unique identifier (e.g. `/foos/foo1`).

Regarding the users, as `terraform-provider-restful` is essentially just a terraform-wrapped API client, practitioners have to know the details of the API for the target platform quite well.