Go API client for openapi

An OpenAPI specification for the OpenAlex API

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.7.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "github.com/diverged/openalex-go-openapi31"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value openapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value openapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using openapi.ContextOperationServerIndices and openapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.openalex.org

Class	Method	HTTP request	Description
DefaultAPI	AutocompleteEntities	Get /autocomplete/{entity_type}	Autocomplete entities
DefaultAPI	ListAuthors	Get /authors	List Authors
DefaultAPI	ListConcepts	Get /concepts	List Concepts
DefaultAPI	ListFunders	Get /funders	List Funders
DefaultAPI	ListInstitutions	Get /institutions	List Institutions
DefaultAPI	ListKeywords	Get /keywords	List Keywords
DefaultAPI	ListPublishers	Get /publishers	List Publishers
DefaultAPI	ListSources	Get /sources	List Sources
DefaultAPI	ListTopics	Get /topics	List Topics
DefaultAPI	ListWorks	Get /works	List Works

Documentation For Models

• Autocomplete
• AutocompleteEntities400Response
• AutocompleteMeta
• AutocompleteResultsInner
• ListAuthors200Response
• ListAuthors200ResponseGroupByInner
• ListAuthors200ResponseMeta
• ListAuthors200ResponseResultsInner
• ListAuthors200ResponseResultsInnerAffiliationsInner
• ListAuthors200ResponseResultsInnerAffiliationsInnerInstitution
• ListAuthors200ResponseResultsInnerCountsByYearInner
• ListAuthors200ResponseResultsInnerIds
• ListAuthors200ResponseResultsInnerLastKnownInstitution
• ListAuthors200ResponseResultsInnerSummaryStats
• ListAuthors200ResponseResultsInnerTopicsInner
• ListAuthors200ResponseResultsInnerTopicsInnerDomain
• ListConcepts200Response
• ListConcepts200ResponseResultsInner
• ListConcepts200ResponseResultsInnerAncestorsInner
• ListConcepts200ResponseResultsInnerIds
• ListConcepts200ResponseResultsInnerInternational
• ListConcepts200ResponseResultsInnerSummaryStats
• ListFunders200Response
• ListFunders200ResponseResultsInner
• ListFunders200ResponseResultsInnerIds
• ListFunders200ResponseResultsInnerRolesInner
• ListFunders200ResponseResultsInnerSummaryStats
• ListInstitutions200Response
• ListInstitutions200ResponseResultsInner
• ListInstitutions200ResponseResultsInnerAssociatedInstitutionsInner
• ListInstitutions200ResponseResultsInnerGeo
• ListInstitutions200ResponseResultsInnerIds
• ListInstitutions200ResponseResultsInnerInternational
• ListInstitutions200ResponseResultsInnerRepositoriesInner
• ListInstitutions200ResponseResultsInnerSummaryStats
• ListKeywords200Response
• ListKeywords200ResponseResultsInner
• ListPublishers200Response
• ListPublishers200ResponseResultsInner
• ListPublishers200ResponseResultsInnerIds
• ListPublishers200ResponseResultsInnerParentPublisher
• ListPublishers200ResponseResultsInnerSummaryStats
• ListSources200Response
• ListSources200ResponseResultsInner
• ListSources200ResponseResultsInnerApcPricesInner
• ListSources200ResponseResultsInnerIds
• ListSources200ResponseResultsInnerSocietiesInner
• ListSources200ResponseResultsInnerSummaryStats
• ListTopics200Response
• ListTopics200ResponseResultsInner
• ListTopics200ResponseResultsInnerDomain
• ListTopics200ResponseResultsInnerField
• ListTopics200ResponseResultsInnerIds
• ListTopics200ResponseResultsInnerSiblingsInner
• ListTopics200ResponseResultsInnerSubfield
• ListWorks200Response
• ListWorks200ResponseMeta
• ListWorks200ResponseResultsInner
• ListWorks200ResponseResultsInnerApcList
• ListWorks200ResponseResultsInnerApcPaid
• ListWorks200ResponseResultsInnerAuthorshipsInner
• ListWorks200ResponseResultsInnerAuthorshipsInnerAffiliationsInner
• ListWorks200ResponseResultsInnerAuthorshipsInnerAuthor
• ListWorks200ResponseResultsInnerBestOaLocation
• ListWorks200ResponseResultsInnerBestOaLocationSource
• ListWorks200ResponseResultsInnerBiblio
• ListWorks200ResponseResultsInnerCountsByYearInner
• ListWorks200ResponseResultsInnerGrantsInner
• ListWorks200ResponseResultsInnerIds
• ListWorks200ResponseResultsInnerLocationsInner
• ListWorks200ResponseResultsInnerMeshInner
• ListWorks200ResponseResultsInnerOpenAccess
• ListWorks200ResponseResultsInnerPrimaryLocation
• ListWorks200ResponseResultsInnerPrimaryTopic
• ListWorks200ResponseResultsInnerSustainableDevelopmentGoalsInner

Documentation For Authorization

Authentication schemes defined for the API:

PoliteEmail

• Type: API key
• API key parameter name: email
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: email and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		openapi.ContextAPIKeys,
		map[string]openapi.APIKey{
			"email": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author