Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add language bindings in implementation guide #92

Merged
merged 2 commits into from
Apr 30, 2024

Conversation

richfab
Copy link
Contributor

@richfab richfab commented Apr 26, 2024

This PR adds a paragraph in the Implementation guide (https://gbfs.org/learn/guide/) to recommend using the TypeScript and Java language bindings.

@@ -175,7 +175,7 @@ The best way to ensure that the feeds you produce are valid, is to generate a da

_A data model generated from the [GBFS JSON schema](https://github.com/MobilityData/gbfs-json-schema) is the safest and most efficient way to transform your data into the GBFS structure._

You can use the [Entur](https://developer.entur.org/) open source [GBFS Java model](https://github.com/entur/gbfs-java-model), generated from the official [GBFS JSON schema](https://github.com/MobilityData/gbfs-json-schema). Or you can find generator tools for many programming languages at [json-schema.org](https://json-schema.org/implementations.html#generators-from-schemas).
To help with the migration to v3.0, we have worked with [Entur](https://developer.entur.org/) to publish GBFS types in TypeScript ([NPM package](https://www.npmjs.com/package/gbfs-typescript-types)) and Java ([Maven Central package](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-java-model)). They are automatically generated from the official [GBFS JSON Schemas](https://github.com/MobilityData/gbfs-json-schema). So when the specification changes, your data model evolves with it. You can find generator tools for many programming languages at [json-schema.org](https://json-schema.org/implementations.html#generators-from-schemas).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Alessandro100 Can you please give me the new Maven Central URL once it is published?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will do!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@richfab richfab merged commit e7f4c51 into master Apr 30, 2024
2 checks passed
@richfab richfab deleted the feat/language-bindings-in-guide branch April 30, 2024 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants