💡  Use cases

Some examples of dev. projects you can build more easily thanks to this toolset.

Creating a Back-for-Front for your app.

This was the main incentive for making Astro OpenAPI.
Being able to federated various API sources, pre-process them, while adding some custom logic (e.g: sessions, guards, user input validation…).

Typically (but not always), your Astro SSR instance is stateless, running on serverless short-lived functions.
You’re sourcing data from external APIs provider, with a mix of in-house micro-services, SaaS, you name it.

While adding a layer of security, you’ll want to structure all that data you’re consuming server side, to finally serve an optimized version to your client browser runtime.

This is called a “Back-For-Front”, or BFF (not to confound with Best-Friend-Forever 🤜🤛).

In order to do that, you could leverage external references to:

  1. Just kind-of proxying API calls with API implementation mirroring
  2. Source just the bit of definitions you need (most likely the entities schemas)
  3. Or make a full facade, without any upstream reference

Those three levels of integration can sit well within you application context (e.g: auth.).

Making your type-safe content server

Operations can be read-only.
With a nice query language you could integrate, for example the excellent Mingo, an agnostic MongoDB-like query implementation.

const homeworks = app.queryContent({
    type: 'homework',
    score: { $gte: 50 },
});

const homeworks = app.queryContent([
    { $match: { type: 'homework' } },
    {
        $group: {
            _id: '$student_id',
            score: { $min: '$score' },
        },
    },
    { $sort: { _id: 1, score: 1 } },
]);

DX-wise, pairing with remark-lint-frontmatter-schema, you can re-use the same schemas for validating redacted Markdown frontmatter, or even pure YAML (with endpoints validation alone).

This code can never land on any server, for example if you’re using this for dev. / pre-processing a static build (an idea for an Astro integration? 😉).

Or maybe you WANT to make it a live content API.
If so, you can source from a backend like Git(Hub), YJS, databases…

Inspirations: nuxt/content, astro-content…