Real live example of OpenAPI in a front-end project

By Maarten Van Hoof

2 min read

Authors

Part of series

Frontend 💜 OpenAPI

  1. Part 1:

    OpenAPI, a contract for RESTFul APIs

  2. Part 2:

    Let me introduce you to OpenAPI

  3. Part 3:

    OpenAPI, the equalizer of API providers and consumers

  4. Part 4:

    Let your RESTful API development soar with OpenAPI tooling

  5. Part 5:

    Real live example of OpenAPI in a front-end project

In the previous parts of this series, we introduced you to the OpenAPI specification, how to describe an API provider in an OpenAPI document, the approaches we can take incorporating it on workflows helping us build and integrate with RESTful APIs, and the tooling that is available to optimise our OpenAPI workflows. In this final part of the series, we will show you how we can use OpenAPI in a front-end monorepo project.

I've created a demo repository showing the power of OpenAPI and automation in a front-end project.

vanhoofmaarten/openapi-monorepo-demo (github.com)

Project structure

The project is set up as a monorepo. Each domain lives as a separate entity in the packages folder, but because they are very much interdependent, they are within the same repository.

.
├── packages/
│   ├── frontend/
│   │   ├── index.html
│   │   ├── main.ts
│   │   └── ...
│   ├── mock/
│   │   └── ...
│   ├── openapi/
│   │   ├── petstore.yml
│   │   └── ...
│   └── sdk/
│       ├── (generated API client)
│       └── ...
├── package.json
└── ...

OpenAPI document

The OpenAPI document is fetched from a different repository using Git submodules. It contains its own linting rules and own automation. We include it in our project to refer to the OpenAPI document itself.

SDK

The sdk folder only contains the configuration and scripts for generating a TypeScript-based API client by openapi-typescript-codegen. Git ignores generated files.

"scripts": {
  "dev": "npm run generate",
  "generate": "openapi --input ../openapi/petstore.yml --output ./src && tsc"
},

Mocks

The mocks folder contains the configuration and scripts to run the Prism mocking server.

"scripts": {
  "dev": "prism mock -d ../openapi/petstore.yml"
}

Front-end

The front-end folder contains a Vite application dependent on the SDK folder. In the main.ts file, we import the PetsService, set the SDK base URL, and fetch data with the listPets method. The retrieved data will be outputted in the HTML element with the id preview.

// Import the generated API client
import { OpenAPI, PetsService } from '../sdk/dist'

// Set the base URL of the API client
OpenAPI.BASE = 'http://localhost:4010'

// Fetch data
const data = await PetsService.listPets(3243)

// Output the data in the HTML
const preview = document.getElementById('preview')

if (preview) {
  preview.innerHTML = JSON.stringify(data, null, 2)
}

Orchestration

With the help of Lerna, a tool to orchestrate monorepo tasks, when running npm run dev, our entire development will start with just one command. First, it will generate the SDK. Then it will start the Vite dev environment and the mocking server in parallel.

➜ npm run dev

> dev
> lerna run --parallel --scope @mrtnvh/*-sdk dev && lerna run --parallel --scope @mrtnvh/*-frontend --scope @mrtnvh/*-mock dev

lerna notice cli v5.1.6
lerna notice filter including "@mrtnvh/*-sdk"
lerna info filter [ '@mrtnvh/*-sdk' ]
lerna info Executing command in 1 package: "npm run dev"
@mrtnvh/frontend-loves-openapi-demo-sdk: > @mrtnvh/frontend-loves-openapi-demo-sdk@0.0.0 dev
@mrtnvh/frontend-loves-openapi-demo-sdk: > npm run generate
@mrtnvh/frontend-loves-openapi-demo-sdk: > @mrtnvh/frontend-loves-openapi-demo-sdk@0.0.0 generate
@mrtnvh/frontend-loves-openapi-demo-sdk: > openapi --input ../openapi/petstore.yml --output ./src && tsc
lerna success run Ran npm script 'dev' in 1 package in 2.0s:
lerna success - @mrtnvh/frontend-loves-openapi-demo-sdk

lerna notice cli v5.1.6
lerna notice filter including ["@mrtnvh/*-frontend","@mrtnvh/*-mock"]
lerna info filter [ '@mrtnvh/*-frontend', '@mrtnvh/*-mock' ]
lerna info Executing command in 2 packages: "npm run dev"
@mrtnvh/frontend-loves-openapi-demo-frontend: > @mrtnvh/frontend-loves-openapi-demo-frontend@0.0.0 dev
@mrtnvh/frontend-loves-openapi-demo-frontend: > vite

@mrtnvh/frontend-loves-openapi-demo-mock: > @mrtnvh/frontend-loves-openapi-demo-mock@0.0.0 dev
@mrtnvh/frontend-loves-openapi-demo-mock: > prism mock -d ../openapi/petstore.yml

@mrtnvh/frontend-loves-openapi-demo-frontend:   vite v2.9.13 dev server running at:
@mrtnvh/frontend-loves-openapi-demo-frontend:   > Local: http://localhost:3000/
@mrtnvh/frontend-loves-openapi-demo-frontend:   > Network: use `--host` to expose
@mrtnvh/frontend-loves-openapi-demo-frontend:   ready in 81ms.

@mrtnvh/frontend-loves-openapi-demo-mock: [2:51:01 PM] › [CLI] …  awaiting  Starting Prism…
@mrtnvh/frontend-loves-openapi-demo-mock: [2:51:01 PM] › [CLI] ℹ  info      GET        http://127.0.0.1:4010/Pets
@mrtnvh/frontend-loves-openapi-demo-mock: [2:51:01 PM] › [CLI] ℹ  info      POST       http://127.0.0.1:4010/Pets
@mrtnvh/frontend-loves-openapi-demo-mock: [2:51:01 PM] › [CLI] ℹ  info      GET        http://127.0.0.1:4010/pets/similique
@mrtnvh/frontend-loves-openapi-demo-mock: [2:51:01 PM] › [CLI] ▶  start     Prism is listening on http://127.0.0.1:4010

When we visit the front-end development server on the provided address, typically at http://localhost:3000, we see our list of mocked data, verifying that our solution works.

Wrap-up

Using this project structure as default in all our projects has helped us reduce project setup time significantly. We can now focus on the end-user, building features that will improve the final product, rather then having to spend time on bootstrapping it.

If you'd made it here so far, thank you for reading! I hope you enjoyed this and that OpenAPI help you improve your API development workflow.

Upcoming events

  • Drupal CMS Launch Party

    Zoals sommigen misschien weten wordt op 15 Januari een nieuwe distributie van Drupal gelanceerd. Namelijk Drupal CMS (ook wel bekend als Starshot). Om dit te vieren gaan we op onze campus een klein eventje organiseren. We gaan die dag samen de livestream volgen waarbij het product gelanceerd wordt. De agenda is als volgt: 17u – 18u30: Drupal CMS livestream met taart 18u30 – 19u00: Versteld staan van de functionaliteiten 19u – 20u: Pizza eten en verder versteld staan van de functionaliteiten Laat ons zeker weten of je komt of niet door de invite te accepteren! Tot dan!

    | Coven of Wisdom Herentals

    Go to page for Drupal CMS Launch Party

  • Coven of Wisdom - Herentals - Winter `24 edition

    Worstelen jij en je team met het bouwen van schaalbare digitale ecosystemen of zit je vast in een props hell met React of in een ander framework? Kom naar onze meetup waar ervaren sprekers hun inzichten en ervaringen delen over het bouwen van robuuste en flexibele applicaties. Schrijf je in voor een avond vol kennis, heerlijk eten en een mix van creativiteit en technologie! 🚀 18:00 – 🚪 Deuren open 18:15 – 🍕 Food & drinks 19:00 – 📢 Building a Mature Digital Ecosystem - Maarten Heip 20:00 – 🍹 Kleine pauze 20:15 – 📢 Compound Components: A Better Way to Build React Components - Sead Memic 21:00 – 🙋‍♀️ Drinks 22:00 – 🍻 Tot de volgende keer? Tijdens deze meetup gaan we dieper in op het bouwen van digitale ecosystemen en het creëren van herbruikbare React componenten. Maarten deelt zijn expertise over het ontwikkelen van een volwassen digitale infrastructuur, terwijl Sead je laat zien hoe je 'From Props Hell to Component Heaven' kunt gaan door het gebruik van Compound Components. Ze delen praktische inzichten die je direct kunt toepassen in je eigen projecten. 📍 Waar? Je vindt ons bij iO Herentals - Zavelheide 15, Herentals. Volg bij aankomst de borden 'meetup' vanaf de receptie. 🎫 Schrijf je in! De plaatsen zijn beperkt, dus RSVP is noodzakelijk. Dit helpt ons ook om de juiste hoeveelheid eten en drinken te voorzien - we willen natuurlijk niet dat iemand met een lege maag naar huis gaat! 😋 Over iO Wij zijn iO: een groeiend team van experts die end-to-end-diensten aanbieden voor communicatie en digitale transformatie. We denken groot en werken lokaal. Aan strategie, creatie, content, marketing en technologie. In nauwe samenwerking met onze klanten om hun merken te versterken, hun digitale systemen te verbeteren en hun toekomstbestendige groei veilig te stellen. We helpen klanten niet alleen hun zakelijke doelen te bereiken. Samen verkennen en benutten we de eindeloze mogelijkheden die markten in constante verandering bieden. De springplank voor die visie is talent. Onze campus is onze broedplaats voor innovatie, die een omgeving creëert die talent de ruimte en stimulans geeft die het nodig heeft om te ontkiemen, te ontwikkelen en te floreren. Want werken aan de infinite opportunities van morgen, dat doen we vandaag.

    | Coven of Wisdom Herentals

    Go to page for Coven of Wisdom - Herentals - Winter `24 edition

  • The Test Automation Meetup

    PLEASE RSVP SO THAT WE KNOW HOW MUCH FOOD WE WILL NEED Test automation is a cornerstone of effective software development. It's about creating robust, predictable test suites that enhance quality and reliability. By diving into automation, you're architecting systems that ensure consistency and catch issues early. This expertise not only improves the development process but also broadens your skillset, making you a more versatile team member. Whether you're a developer looking to enhance your testing skills or a QA professional aiming to dive deeper into automation, RSVP for an evening of learning, delicious food, and the fusion of coding and quality assurance! 🚀🚀 18:00 – 🚪 Doors open to the public 18:15 – 🍕 Let’s eat 19:00 – 📢 First round of Talks 19:45 – 🍹 Small break 20:00 – 📢 Second round of Talks 20:45 – 🍻 Drinks 21:00 – 🙋‍♀️ See you next time? First Round of Talks: The Power of Cross-browser Component Testing - Clarke Verdel, SR. Front-end Developer at iO How can you use Component Testing to ensure consistency cross-browser? Overcoming challenges in Visual Regression Testing - Sander van Surksum, Pagespeed | Web Performance Consultant and Sannie Kwakman, Freelance Full-stack Developer How can you overcome the challenges when setting up Visual Regression Testing? Second Round of Talks: Omg who wrote this **** code!? - Erwin Heitzman, SR. Test Automation Engineer at Rabobank How can tests help you and your team? Beyond the Unit Test - Christian Würthner, SR. Android Developer at iO How can you do advanced automated testing for, for instance, biometrics? RSVP now to secure your spot, and let's explore the fascinating world of test automation together!

    | Coven of Wisdom - Amsterdam

    Go to page for The Test Automation Meetup

Share

Jobs

Front-end Developer (Drupal)

Brussel, Brussels Hoofdstedelijk Gewest, België

Backend Developer

Brussel, Brussels Hoofdstedelijk Gewest, België

Senior Web Developer

Sofia, Sofia, Bulgarije

Front-end Developer

Rotterdam, Zuid-Holland, Nederland

View all jobs