There are no practical examples of how to use this library in the documentation

[k98kurz]

Description

The documentation would be significantly improved if it started with some practical examples of how to use the library rather than just listing out concepts and compatibility tables. E.g.

use Jose\Component\Signature\JWSVerifierFactory;

// How to actually use this properly given a JWT string.
// I would put it here myself but I haven't figure it out yet
// because the docs are so dense and impractical.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[k98kurz]

Bump

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[k98kurz]

Bump

[Spomky]

Hi,

This page should help: https://web-token.spomky-labs.com/the-components/examples

Regards.

[k98kurz]

@Spomky 16 imports to just check if a JWT is valid is crazy verbose. Is this library meant to mostly be used with wrapper libraries?

[Spomky]

Hi @k98kurz,

You are absolutely right that the low-level API of the framework can feel verbose. That's by design: the library aims to provide granular control over all aspects of JWT handling (key selection, algorithm constraints, header checks, etc.).

That said, you are not alone in finding the API too verbose for simple use cases. I previously experimented with providing a single entrypoint class to simplify common operations like signature verification and token decryption. Unfortunately, those attempts weren't conclusive; there were too many edge cases to cover cleanly without sacrificing clarity or flexibility.

I do plan to provide helpers to improve the developer experience. This has been on my todolist for a while. I just haven’t had enough time lately to get to it.