Citation API

Norma

Zdroj normy ISO690:2022: Výklad ISO690:2022 PDF

Příklady: Příklady ISO690:2022

MLA 9(2021): easybib.com

Bibtex: bibtex.eu

Wiki monografie: citace monografie

Wiki periodikum: citace periodika

RIS RIS na wiki

RIS RIS na Refman

Projekt

GitHub: https://github.com/ceskaexpedice/kramerius-citace

Popis API

/api/v1

Např. http://localhost:3000/api/v1?uuid=uuid:869e4730-6c8b-11e2-8ed6-005056827e52&exp=iso690&format=html&lang=cs

Parametry:

• uuid: UUID objektu. Povinny parametr.
• exp: iso690 | mla | bibtex | wiki | ris | all (default vrací iso690 ve formátu txt).
• format: txt | html (default vrací pro všechny exp).
• lang: cs | en | de | sk (default = cs)
• ref: string citace s / bez odkazu na digitální dokument (default = false)
• debug: true | false citace s api a MODS dokumentu pro kontrolu (default = false)

Použití v uživatelském rozhraní Krameria

Doplňte do /assets/shared/globals.js

var APP_GLOBAL = {
...
  citationService: 'https://citace.ceskadigitalniknihovna.cz',
  citationServiceType: 'new',
  krameriusList: [
...

Provoz

Instalace závislostí

npm install

Spuštění (vývoj)

npm run dev

Spuštění (produkční)

npm run start

Docker

Distribuce Docker image

Build

docker build -t citation-api .

případně včetně tagu verze

docker build -t ceskaexpedice/citation-api:1.1.0 .

případně včetně tagu verze a tagu latest

docker build -t ceskaexpedice/citation-api:latest -t ceskaexpedice/citation-api:1.1.0 .

Hostování

https://hub.docker.com/r/ceskaexpedice/citation-api/tags

docker push ceskaexpedice/citation-api:1.1.0
docker push ceskaexpedice/citation-api:latest

Spuštění Docker image

Lokální image

docker run -p 3000:3000 citation-api

případně konkrétní verzi

docker run -p 3000:3000 ceskaexpedice/citation-api:latest

Docker Hub

docker pull ceskaexpedice/citation-api:latest
docker run -p 3000:3000 ceskaexpedice/citation-api

Na nestandardním portu

Vnější (host) port lze změnit takto:

docker run -p 1234:3000 ceskaexpedice/citation-api

API

Webová dokumentace je dostupná na nasezené aplikaci, na cestě /api-docs.

https://citace.ceskadigitalniknihovna.cz/api-docs/

build OpenAPI dokumentace

Dokumentace se upravuje v souborech v adresáři openapi-src. Následně je potřeba z těchto soborů vygenerovat výsledný soubor openapi.json takto: swagger-cli bundle openapi-src/__api.yaml -o openapi.json

validace openapi.json

Po větším množství změn je vhodně validovat soubor openapi.json. I nevalidní soubor sice může fungovat, ale jen částečně. Validaci spustíme takto: swagger-cli validate openapi.json