generic-hypermedia-api-client v0.0.3

Generieke Hypermedia API client

Er wordt gebouwd aan een specificatie van generieke bouwblokken voor API's in Vlaanderen. Dit is deel van de onderzoeksgroep Werkgroep datastandaarden van het Stuurorgaan.

Een generieke hypermedia API beschrijft in elke respons de verdere stappen die vanaf dat punt kunnen worden genomen met Hypermedia controls. Een client kan vervolgens een generieke afhandeling voorzien voor elk van deze bouwblokken. In deze repository wordt de clientside implementatie van deze bouwblokken voorzien.

Implementatie van de generieke bouwblokken

De bouwblokken die reeds geïmplementeerd zijn:

• Metadata
• Paginering
• Taal
• Versionering
• Full Text Search
• CRUD

Om gebruik te kunnen maken van deze bouwblokken is een ApiClient nodig.

Installatie

Als eerste dient de repository gecloned te worden. Vervolgens moet naar de folder genavigeerd worden en de benodigde node_modules geïnstalleerd worden:

> git clone https://github.com/Informatievlaanderen/generic-hypermedia-api-client
> cd generic-hypermedia-api-client
> npm install

Om gebruik te maken van de module zie de volgende sectie.

Bin usage

Na installatie van het project kan de package eenvoudig getest worden via een bin script. Hiervoor dient de gebruiker het volgende commando uit te voeren:

> (navigeer eerst naar de /bin folder)
> generic-hypermedia-api-client URL handler_1 handler_2 ...

Browser usage

Na installatie van het project kan de package gebouwd worden voor gebruik in een browser-omgeving. Hiervoor dient de gebruiker het volgende commando uit te voeren:

> npm run build

Vervolgens kan het bestand dist/main.js hergebruikt worden in een webapplicatie via de script-tag:

<script src="./dist/main.js"></script>
<script>
function getPaginationControls(_url) {
  return new Promise(resolve => {
    let client = new window.ghaclient.ApiClient(null);
    const paginationHandler = new window.ghaclient.PaginationHandler({
      pagedataCallback: (pagedata) => resolve(pagedata),
      subjectStream: client.subjectStream
    });
    client.fetch(_url, [paginationHandler]);
  });
}
let main = async function () {
  let paginationControls = await getPaginationControls('http://tw06v036.ugent.be/api/pagination');
  console.log(paginationControls);
}
try {
  main();
} catch (e) {
  console.error(e);
}
</script>

Of gebruik een CDN om direct aan de slag te kunnen: <script src="https://cdn.jsdelivr.net/npm/generic-hypermedia-api-client@0.0.1/dist/main.js"></script>

Handlers

De handler werden gemapt op hun naam zonder de suffix Handler. Per handler kunnen ook verschillende opties meegegeven worden.

metadata (MetadataHandler)

• --followdoclink : volg een gevonden api documentatie link

pagination (PaginationHandler)

Geen opties mogelijk

language (LanguageHandler)

• -l : verwacht een de waarde voor een Accept-Language header

versioning (VersioningHandler)

• --followversionlink : volg de geversioneerde URL als deze gevonden wordt

full_text_search (FullTextSearchHandler)

• --queryurl: fetch de template URL met ingevulde parameters
• -v : waarden om als values in te vullen in de template URL
• -k : waarden om als keys in te vullen in de template URL

crud (CRUDHandler)

Geen opties mogelijk

Voorbeeld

> generic-hypermedia-api-client http://tw06v036.ugent.be/api/all metadata pagination

Dit commando zal de URL http://tw06v036.ugent.be/api/all fetchen en daarna zullen de MetadataHandler en PaginationHandler de data verwerken.

> generic-hypermedia-api-client http://tw06v036.ugent.be/api/language language -l nl,en;q=0.9

Dit commando zal de URL http://tw06v036.ugent.be/api/language fetchen waarbij de Accept-Language header meegestuurd wordt met de waarde nl,en;q=0.9. De ontvangen data wordt door de LanguageHandler gestuurd.

Endpoints

• Zie Generic-Hypermedia-API-Client-testserver

Testen

Om te testen kan gebruik gemaakt worden van de Generieke-Hypermedia-API-Client-Testserver. Dit is een server die enkel data teruggeeft en is te bereiken op http://tw06v036.ugent.be/api.

Voorbeeld van data voor de metadataHandler:

{
        "@context": [
            "http://www.w3.org/ns/hydra/context.jsonld",
            "https://raw.githubusercontent.com/SEMICeu/DCAT-AP/master/releases/1.1/dcat-ap_1.1.jsonld",
            {
                "hydra": "http://www.w3.org/ns/hydra/core#",
                "dc": "http://purl.org/dc/terms/",
                "dcat": "https://www.w3.org/ns/dcat#",
                "hydra:apiDocumentation" : { "@type" : "@id"}
            }
        ],
        "@id": "/api",
        "@type": ["EntryPoint", "Distribution"],
        "hydra:apiDocumentation": "/api/documentation",
        "dc:issued": "2016-01-10",
        "dc:modified": "2018-07-24"
};

Meer voorbeelden van data kunnen gevonden worden bij de beschrijving van de bouwblokken in de repository van de Generieke Hypermedia API.

Testen van de bouwblokken - Voorbeelden

Na installatie van de (npm-)package kunnen de verschillende handlers op volgende manier getest worden:

• MetadataHandler

const client = new ApiClient(null);
const metadataHandler = new MetadataHandler(
                {
                    metadataCallback: (metadata) => console.log(metadata),
                    apiClient: client,
                    followDocumentationLink: true, //If there's an api documentation link, it will be fetched. You can set it to false if you want!
                }
            );
client.fetch('http://tw06v036.ugent.be/api', [ metadataHandler ]);

• PaginationHandler

const client = new ApiClient(null);
const pagineringHandler = new PaginationHandler(
                {
                    pagedataCallback: (pagedata) => console.log(pagedata),
                    subjectStream: client.subjectStream
                }
            )
client.fetch('http://tw06v036.ugent.be/api/pagination', [ pagineringHandler ]); 

• LanguageHandler

const client = new ApiClient(null);
const languageHandler = new LanguageHandler(
                {
                    languageCallback: (language) => {
                        language.stream.on('data', (data) => {
                            if (typeof data === 'object') {
                                console.log(data.object.value);
                            } else {
                                console.log(data);
                            }
                        })
                    },
                    acceptLanguageHeader: 'nl,en;q=0.8'  //The Accept-Language header string    (supported languages on the server are nl, fr and en)
                }
            )
client.fetch('http://tw06v036.ugent.be/api/language', [ languageHandler ]);

• VersioningHandler

const client = new ApiClient(null);
const versioningHandler = new VersioningHandler({
                versionCallback: version => {
                    version.stream.on('data' , (data) => {
                        console.log(data);
                    })
                },
                apiClient: client,
                datetime: new Date(2018, 8, 14 ),
                followLink: false
            })
client.fetch('http://tw06v036.ugent.be/api/versioning', [ versioningHandler ]);

• FullTextSearchHandler

const client = new ApiClient(null);
const fts = new FullTextSearchHandler({
        callback: (fts) => {
            fts.stream.on('data', (data) => {
                console.log(data);
            })
        },
        apiClient: client,
        queryValues: ['Bob']
        //queryKeys: ['Naam']   //Optioneel
});
client.fetch('http://tw06v036.ugent.be/api/fullTextSearch', [ fts ]);

• CRUDHandler

const client = new ApiClient(null);
const crud = new CRUDHandler({
        crudCallback: (crud) => console.log(crud)
});
client.fetch('http://tw06v036.ugent.be/api/crud/1', [ crud ]);

Het is ook mogelijk om meerdere bouwblokken samen te testen. Je maakt de handlers aan, zoals hierboven beschreven en geeft ze mee in de array. De URL die je hier best voor gebruikt is http://tw06v036.ugent.be/api/all.

const client = new ApiClient(null);
const metadataHandler = new MetadataHandler(
                {
                    metadataCallback: (metadata) => console.log(metadata),
                    apiClient: client,
                    followDocumentationLink: true, //If there's an api documentation link, it will be fetched. You can set it to false if you want!
                }
            );
const pagineringHandler = new PaginationHandler(
                {
                    pagedataCallback: (pagedata) => console.log(pagedata),
                    subjectStream: client.subjectStream
                }
            );
client.fetch('http://tw06v036.ugent.be/api/all', [ metadataHandler, pagineringHandler ]);