Skip to content

catleeball/worldcat-api-client-go

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Go API client for openapi

Searching of WorldCat

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: 2.0.0
  • Package version: 1.0.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/oauth2
go get golang.org/x/net/context

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

import openapi "github.com/catleeball/worldcat-api-client-go"

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 sw.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 sw.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 sw.ContextOperationServerIndices and sw.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://americas.discovery.api.oclc.org/worldcat/search/v2

Class Method HTTP request Description
BibliographicResourcesApi RetrieveBib Get /bibs/{oclcNumber} Retrieve specific Bibliographic Resource
BibliographicResourcesApi RetrieveBriefBib Get /brief-bibs/{oclcNumber} Retrieve specific Bibliographic Resource
BibliographicResourcesApi RetrieveOtherEditions Get /brief-bibs/{oclcNumber}/other-editions Retrieve Other Editions related to a particular Bibliographic Resource
BibliographicResourcesApi SearchBibs Get /bibs Search Bibliographic Resources
BibliographicResourcesApi SearchBriefBibs Get /brief-bibs Search Brief Bibliographic Resources
LocalHoldingsResourcesApi RetrieveLhr Get /my-holdings/{controlNumber} Retrieve LHR Resource
LocalHoldingsResourcesApi SearchLhr Get /my-holdings Search LHR Resources
LocalHoldingsResourcesApi SearchRetrainedLhr Get /retained-holdings Search for shared print LHR Resources
MemberGeneralHoldingsApi FindBibDetailedHoldings Get /bibs-detailed-holdings Find detailed info of member holdings for a known item
MemberGeneralHoldingsApi FindBibHoldings Get /bibs-holdings Find member holdings for a known item
MemberGeneralHoldingsApi FindBibSummaryHoldings Get /bibs-summary-holdings Get summary of holdings for a known item
MemberSharedPrintHoldingsApi FindBibRetainedHoldings Get /bibs-retained-holdings Find member shared print holdings for a known item

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

worldcat_search_auth

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • wcapi: perform all the operation in the WorldCat Search API
  • wcapi:view_bib: view bibliographic data
  • wcapi:view_brief_bib: view brief bibliographic data
  • wcapi:view_retained_holdings: view holdings which libraries have chosen to retain
  • wcapi:view_summary_holdings: view summary information about library holdings
  • wcapi:view_my_holdings: view detailed information about the authentication institution's holdings
  • wcapi:view_institution_holdings: view information about what library holds an item
  • wcapi:view_holdings: view detailed information about library holdings

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

worldcat_search_auth

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://oauth.oclc.org/auth
  • Scopes:
  • wcapi: perform all the operation in the Discovery domain
  • wcapi:view_bib: view bibliographic data
  • wcapi:view_brief_bib: view brief bibliographic data
  • wcapi:view_retained_holdings: view holdings which libraries have chosen to retain
  • wcapi:view_summary_holdings: view summary information about library holdings
  • wcapi:view_my_holdings: view detailed information about the authentication institution's holdings
  • wcapi:view_institution_holdings: view information about what library holds an item
  • wcapi:view_holdings: view detailed information about library holdings

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
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

About

Generated by OpenAPI Generator

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages