Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/contentful-labs/contentful-go
Contentful api SDK for GoLang
https://github.com/contentful-labs/contentful-go
contentful golang sdk
Last synced: 14 days ago
JSON representation
Contentful api SDK for GoLang
- Host: GitHub
- URL: https://github.com/contentful-labs/contentful-go
- Owner: contentful-labs
- License: mit
- Archived: true
- Created: 2016-12-10T17:28:31.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-09-12T14:26:30.000Z (over 2 years ago)
- Last Synced: 2024-10-02T07:42:14.977Z (4 months ago)
- Topics: contentful, golang, sdk
- Language: Go
- Homepage:
- Size: 334 KB
- Stars: 45
- Watchers: 6
- Forks: 63
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
[](https://godoc.org/github.com/contentful-labs/contentful-go)
[](https://opensource.org/licenses/MIT)
[](https://travis-ci.com/contentful-labs/contentful-go)
❗ Disclaimer
=====
**This project is not actively maintained or monitored.** Feel free to fork and work on it in your account. If you want to maintain but also collaborate with fellow developers, feel free to reach out to [Contentful's Developer Relations](mailto:[email protected]) team to move the project into our community GitHub organisation [contentful-userland](https://github.com/contentful-userland/).
# contentful-go
GoLang SDK for [Contentful's](https://www.contentful.com) Content Delivery, Preview and Management API's.
# About
[Contentful](https://www.contentful.com) provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.
[Go](https://golang.org) is an open source programming language that makes it easy to build simple, reliable, and efficient software.
# Install
`go get github.com/contentful-labs/contentful-go`
# Getting started
Import into your Go project or library
```go
import (
contentful "github.com/contentful-labs/contentful-go"
)
```
Create a API client in order to interact with the Contentful's API endpoints.
```go
token := "your-cma-token" // observe your CMA token from Contentful's web page
cma := contentful.NewCMA(token)
```
#### Organization
If your Contentful account is part of an organization, you can setup your API client as so. When you set your organization id for the SDK client, every api request will have `X-Contentful-Organization: ` header automatically.
```go
cma.SetOrganization("your-organization-id")
```
#### Debug mode
When debug mode is activated, sdk client starts to work in verbose mode and try to print as much informatin as possible. In debug mode, all outgoing http requests are printed nicely in the form of `curl` command so that you can easly drop into your command line to debug specific request.
```go
cma.Debug = true
```
#### Dependencies
`contentful-go` stores its dependencies under `vendor` folder and uses [`dep`](https://github.com/golang/dep) to manage dependency resolutions. Dependencies in `vendor` folder will be loaded automatically by [Go 1.6+](https://golang.org/cmd/go/#hdr-Vendor_Directories). To install the dependencies, run `dep ensure`, for more options and documentation please visit [`dep`](https://github.com/golang/dep).
# Using the SDK
## Working with resource services
Currently SDK exposes the following resource services:
* Spaces
* APIKeys
* Assets
* ContentTypes
* Entries
* Locales
* Webhooks
Every resource service has at least the following interface:
```go
List() *Collection
Get(spaceID, resourceID string) , error
Upsert(spaceID string, resourceID *Resource) error
Delete(spaceID string, resourceID *Resource) error
```
#### Example
```go
space, err := cma.Spaces.Get("space-id")
if err != nil {
log.Fatal(err)
}
collection := cma.ContentTypes.List(space.Sys.ID)
collection, err = collection.Next()
if err != nil {
log.Fatal(err)
}
for _, contentType := range collection.ToContentType() {
fmt.Println(contentType.Name, contentType.Description)
}
```
## Working with collections
All the endpoints which return an array of objects are wrapped around `Collection` struct. The main features of `Collection` are pagination and type assertion.
### Pagination
WIP
### Type assertion
`Collection` struct exposes the necessary converters (type assertion) such as `ToSpace()`. The following example gets all spaces for the given account:
### Example
```go
collection := cma.Spaces.List() // returns a collection
collection, err := collection.Next() // makes the actual api call
if err != nil {
log.Fatal(err)
}
spaces := collection.ToSpace() // make the type assertion
for _, space := range spaces {
fmt.Println(space.Name)
fmt.Println(space.Sys.ID)
}
// In order to access collection metadata
fmt.Println(col.Total)
fmt.Println(col.Skip)
fmt.Println(col.Limit)
```
## Testing
```shell
$> go test
```
To enable higher verbose mode
```shell
$> go test -v -race
```
## Documentation/References
### Contentful
[Content Delivery API](https://www.contentful.com/developers/docs/references/content-delivery-api/)
[Content Management API](https://www.contentful.com/developers/docs/references/content-management-api/)
[Content Preview API](https://www.contentful.com/developers/docs/references/content-preview-api/)
### GoLang
[Effective Go](https://golang.org/doc/effective_go.html)
## Support
This is a project created for demo purposes and not officially supported, so if you find issues or have questions you can let us know via the [issue](https://github.com/contentful-labs/contentful-go/issues/new) page but don't expect a quick and prompt response.
## Contributing
[WIP]
## License
MIT