From 7499aa72fc92215b17a6b61eeae5102d314987db Mon Sep 17 00:00:00 2001 From: Fabien Richard-Allouard Date: Mon, 16 Sep 2024 16:20:24 +0200 Subject: [PATCH] Update Implementation Guide with Rust types library (#99) * Update guide to include Rust types library * Move up the Libraries section to make it more visible --- docs/en/learn/guide.md | 2 +- docs/en/toolbox/resources.md | 34 ++++++++++++------------ docs/es/learn/guide.md | 2 +- docs/es/toolbox/resources.md | 34 ++++++++++++------------ docs/fr/learn/guide.md | 2 +- docs/fr/toolbox/resources.md | 50 ++++++++++++++++++------------------ 6 files changed, 62 insertions(+), 62 deletions(-) diff --git a/docs/en/learn/guide.md b/docs/en/learn/guide.md index b8e5498..737fde5 100644 --- a/docs/en/learn/guide.md +++ b/docs/en/learn/guide.md @@ -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._ -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.mobilitydata/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). +You can find data models for the main programming languages (Java, TypeScript, Rust, etc) in the [Community Tools and Resources](../toolbox/resources.md#libraries). 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. For other programming languages, you can find generator tools at [json-schema.org](https://json-schema.org/tools?query=&sortBy=name&sortOrder=ascending&groupBy=toolingTypes&licenses=&languages=&drafts=&toolingTypes=#schema-to-code). Creating a data model manually from the [GBFS reference](https://github.com/MobilityData/gbfs/blob/master/gbfs.md) is possible but not recommended as it is error prone and more difficult to update when the GBFS specification changes. diff --git a/docs/en/toolbox/resources.md b/docs/en/toolbox/resources.md index f0724c3..1b4357d 100644 --- a/docs/en/toolbox/resources.md +++ b/docs/en/toolbox/resources.md @@ -4,6 +4,23 @@ There are a multitude of tools and services available to help with the creation,
+## Libraries + +### Language bindings for GBFS + +- [Java](https://central.sonatype.com/artifact/org.mobilitydata/gbfs-java-model): GBFS types in Java. Developed by Entur, hosted by MobilityData. +- [TypeScript](https://www.npmjs.com/package/gbfs-typescript-types): GBFS types in TypeScript. Hosted by MobilityData. +- [Rust](https://crates.io/crates/gbfs_types): GBFS types in Rust. Maintained by Fluctuo. +- [R](https://github.com/simonpcouch/gbfs): GBFS types in R. + +### Tools + +- [BikeshareClient](https://github.com/andmos/BikeshareClient): dotnet client for GBFS written in C#. Enables dotnet developers to create apps and services using data from GBFS Bikeshare systems. +- [Java Version Mapper](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-mapper-java): Java implementation of mapping between different versions of GBFS (bidirectional). Maintained by Entur. +- [Java Feed Loader](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-loader-java): Java implementation to manage loading of GBFS feeds and updating them based on their ttl and last_updated fields. Maintained by Entur. + +
+ ## Data ### Third Party GBFS URL Directories @@ -77,23 +94,6 @@ There are a multitude of tools and services available to help with the creation,
-## Libraries - -### Language bindings for GBFS - -- [Java](https://central.sonatype.com/artifact/org.mobilitydata/gbfs-java-model): GBFS types in Java. Developed by Entur, hosted by MobilityData. -- [TypeScript](https://www.npmjs.com/package/gbfs-typescript-types): GBFS types in TypeScript. Hosted by MobilityData. -- [Rust](https://crates.io/crates/gbfs_types): GBFS types in Rust. Maintained by Fluctuo. -- [R](https://github.com/simonpcouch/gbfs): GBFS types in R. - -### Tools - -- [BikeshareClient](https://github.com/andmos/BikeshareClient): dotnet client for GBFS written in C#. Enables dotnet developers to create apps and services using data from GBFS Bikeshare systems. -- [Java Version Mapper](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-mapper-java): Java implementation of mapping between different versions of GBFS (bidirectional). Maintained by Entur. -- [Java Feed Loader](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-loader-java): Java implementation to manage loading of GBFS feeds and updating them based on their ttl and last_updated fields. Maintained by Entur. - -
- ## Validators - [Go Validator](https://github.com/petoc/gbfs): Go implementation of client, server and validator for GBFS diff --git a/docs/es/learn/guide.md b/docs/es/learn/guide.md index affd053..a791547 100644 --- a/docs/es/learn/guide.md +++ b/docs/es/learn/guide.md @@ -174,7 +174,7 @@ La mejor manera de garantizar que los feeds que produce sean válidos es generar _Un modelo de datos generado a partir del [esquema GBFS JSON](https://github.com/MobilityData/gbfs-json-schema) es la forma más segura y eficiente de transformar sus datos en la estructura GBFS._ -Para ayudar con la migración a v3.0, hemos trabajado con [Entur](https://developer.entur.org/) para publicar tipos GBFS en TypeScript ([paquete NPM](https://www.npmjs.com/package/gbfs-typescript-types)) y Java ([paquete Maven Central](https://central.sonatype.com/artifact/org.mobilitydata/org.mobilitydata-java-model)). Se generan automáticamente a partir de los [esquemas JSON GBFS] oficiales (https://github.com/MobilityData/gbfs-json-schema). Entonces, cuando la especificación cambia, su modelo de datos evoluciona con ella. Puede encontrar herramientas generadoras para muchos lenguajes de programación en [json-schema.org](https://json-schema.org/implementations.html#generators-from-schemas). +Puede encontrar modelos de datos para los principales lenguajes de programación (Java, TypeScript, Rust, etc.) en las [Herramientas y recursos comunitarios](../toolbox/resources.md#bibliotecas). Se generan automáticamente a partir de los [esquemas GBFS JSON](https://github.com/MobilityData/gbfs-json-schema) oficiales. Entonces, cuando la especificación cambia, su modelo de datos evoluciona con ella. Para otros lenguajes de programación, puede encontrar generadores en [json-schema.org](https://json-schema.org/tools?query=&sortBy=name&sortOrder=ascending&groupBy=toolingTypes&licenses=&languages=&drafts=&toolingTypes=#schema-to-code). Crear un modelo de datos manualmente desde la [referencia de GBFS](https://github.com/MobilityData/gbfs/blob/master/gbfs.md) es posible, pero no recomendado, ya que es propenso a errores y más difícil de actualizar cuando cambia la especificación GBFS. diff --git a/docs/es/toolbox/resources.md b/docs/es/toolbox/resources.md index 4815ef1..2a2f707 100644 --- a/docs/es/toolbox/resources.md +++ b/docs/es/toolbox/resources.md @@ -4,6 +4,23 @@ Hay una multitud de herramientas y servicios disponibles para ayudar con la crea
+## Bibliotecas + +### Enlaces de lenguaje para GBFS + +- [Java](https://central.sonatype.com/artifact/org.mobilitydata/gbfs-java-model): tipos de GBFS en Java. Desarrollado por Entur, alojado en MobilityData. +- [TypeScript](https://www.npmjs.com/package/gbfs-typescript-types): tipos GBFS en TypeScript. Organizado por MobilityData. +- [Rust](https://crates.io/crates/gbfs_types): tipos de GBFS en Rust. Mantenido por Fluctuo. +- [R](https://github.com/simonpcouch/gbfs): Tipos de GBFS en R. + +### Herramientas + +- [BikeshareClient](https://github.com/andmos/BikeshareClient) : cliente dotnet para GBFS escrito en C#. Permite a los desarrolladores de dotnet crear aplicaciones y servicios utilizando datos de los sistemas GBFS Bikeshare. +- [Java Version Mapper](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-mapper-java): implementación de Java de mapeo entre diferentes versiones de GBFS (bidireccional). Mantenido por Entur. +- [Java Feed Loader](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-loader-java): Implementación de Java para gestionar la carga de feeds GBFS y actualizarlos en función de sus campos ttl y last_updated. Mantenido por Entur. + +
+ ## Data ### Directorios URL de GBFS de terceros @@ -77,23 +94,6 @@ Hay una multitud de herramientas y servicios disponibles para ayudar con la crea
-## Bibliotecas - -### Enlaces de lenguaje para GBFS - -- [Java](https://central.sonatype.com/artifact/org.mobilitydata/gbfs-java-model): tipos de GBFS en Java. Desarrollado por Entur, alojado en MobilityData. -- [TypeScript](https://www.npmjs.com/package/gbfs-typescript-types): tipos GBFS en TypeScript. Organizado por MobilityData. -- [Rust](https://crates.io/crates/gbfs_types): tipos de GBFS en Rust. Mantenido por Fluctuo. -- [R](https://github.com/simonpcouch/gbfs): Tipos de GBFS en R. - -### Herramientas - -- [BikeshareClient](https://github.com/andmos/BikeshareClient) : cliente dotnet para GBFS escrito en C#. Permite a los desarrolladores de dotnet crear aplicaciones y servicios utilizando datos de los sistemas GBFS Bikeshare. -- [Java Version Mapper](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-mapper-java): implementación de Java de mapeo entre diferentes versiones de GBFS (bidireccional). Mantenido por Entur. -- [Java Feed Loader](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-loader-java): Implementación de Java para gestionar la carga de feeds GBFS y actualizarlos en función de sus campos ttl y last_updated. Mantenido por Entur. - -
- ## Validadores - [Go Validator](https://github.com/petoc/gbfs): Implementación Go de cliente, servidor y validador para GBFS diff --git a/docs/fr/learn/guide.md b/docs/fr/learn/guide.md index 578bad8..c9634cc 100644 --- a/docs/fr/learn/guide.md +++ b/docs/fr/learn/guide.md @@ -174,7 +174,7 @@ La meilleure façon de s'assurer que les flux que vous produisez sont valides es _Un modèle de données généré à partir du [schéma JSON GBFS](https://github.com/MobilityData/gbfs-json-schema) est le moyen le plus sûr et le plus efficace de transformer vos données dans la structure GBFS._ -Pour faciliter la migration vers la v3.0, nous avons travaillé avec [Entur](https://developer.entur.org/) pour publier des types GBFS en TypeScript ([package NPM](https://www.npmjs.com/package/gbfs-typescript-types)) et en Java ([package Maven Central](https://central.sonatype.com/artifact/org.mobilitydata/gbfs-java-model)). Ils sont automatiquement générés à partir des [schémas JSON GBFS] officiels (https://github.com/MobilityData/gbfs-json-schema). Ainsi, lorsque le standard change, votre modèle de données évolue en même temps. Vous pouvez trouver des outils générateurs pour de nombreux langages de programmation sur [json-schema.org](https://json-schema.org/implementations.html#generators-from-schemas). +Vous pouvez trouver des modèles de données pour les principaux langages de programmation (Java, TypeScript, Rust, etc.) dans les [Outils et Ressources](../toolbox/resources.md#bibliotheques). Ils sont automatiquement générés à partir des [schémas JSON GBFS](https://github.com/MobilityData/gbfs-json-schema) officiels. Ainsi, lorsque le standard change, votre modèle de données évolue en même temps. Pour les autres langages de programmation, vous pouvez trouver des générateurs sur [json-schema.org](https://json-schema.org/tools?query=&sortBy=name&sortOrder=ascending&groupBy=toolingTypes&licenses=&languages=&drafts=&toolingTypes=#schema-to-code). La création manuelle d'un modèle de données à partir de la [référence GBFS](https://github.com/MobilityData/gbfs/blob/master/gbfs.md) est possible mais n'est pas recommandée car elle est sujette aux erreurs et plus difficile à mettre à jour lorsque la spécification GBFS change. diff --git a/docs/fr/toolbox/resources.md b/docs/fr/toolbox/resources.md index 0c69076..81a3ad7 100644 --- a/docs/fr/toolbox/resources.md +++ b/docs/fr/toolbox/resources.md @@ -4,6 +4,31 @@ Il existe une multitude d'outils et de services disponibles pour aider à la cr
+## Bibliothèques + +### Liaisons linguistiques pour GBFS + +- [Java](https://central.sonatype.com/artifact/org.mobilitydata/gbfs-java-model): Modèle de données GBFS en Java. Développé par Entur, hébergé par MobilityData. +- [TypeScript](https://www.npmjs.com/package/gbfs-typescript-types): Types GBFS en TypeScript. Hébergé par MobilityData. +- [Rust](https://crates.io/crates/gbfs_types): Modèle de données GBFS en Rust. Maintenu par Fluctuo. +- [R](https://github.com/simonpcouch/gbfs): Modèle de données GBFS en R. + +### Les outils + +- [BikeshareClient](https://github.com/andmos/BikeshareClient): client dotnet pour GBFS écrit en C#. Permet aux développeur·euses dotnet de créer des applications et des services utilisant les données des systèmes GBFS. +- [Java Version Mapper](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-mapper-java): Implémentation Java du mapping entre les différentes versions de GBFS (bidirectionnel). Maintenu par Entur. +- [Java Feed Loader](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-loader-java): Implémentation Java pour gérer le chargement des flux GBFS et leur mise à jour en fonction des champs ttl et last_updated. Maintenu par Entur. + +
+ +## Validateurs + +- [Go Validator](https://github.com/petoc/gbfs): Implémentation Go du client, du serveur et du validateur pour GBFS. +- [Validateur Java](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-validator-java): Implémentation Java du validateur pour GBFS. Maintenu par Entur. +- [npm](https://www.npmjs.com/package/@entur/gbfs-validator): Paquet Javascript du validateur [gbfs](https://github.com/MobilityData/gbfs-validator). Maintenu par Entur. + +
+ ## Données ### Répertoires d'URL GBFS @@ -76,31 +101,6 @@ Il existe une multitude d'outils et de services disponibles pour aider à la cr
-## Bibliothèques - -### Liaisons linguistiques pour GBFS - -- [Java](https://central.sonatype.com/artifact/org.mobilitydata/gbfs-java-model): Modèle de données GBFS en Java. Développé par Entur, hébergé par MobilityData. -- [TypeScript](https://www.npmjs.com/package/gbfs-typescript-types): Types GBFS en TypeScript. Hébergé par MobilityData. -- [Rust](https://crates.io/crates/gbfs_types): Modèle de données GBFS en Rust. Maintenu par Fluctuo. -- [R](https://github.com/simonpcouch/gbfs): Modèle de données GBFS en R. - -### Les outils - -- [BikeshareClient](https://github.com/andmos/BikeshareClient): client dotnet pour GBFS écrit en C#. Permet aux développeur·euses dotnet de créer des applications et des services utilisant les données des systèmes GBFS. -- [Java Version Mapper](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-mapper-java): Implémentation Java du mapping entre les différentes versions de GBFS (bidirectionnel). Maintenu par Entur. -- [Java Feed Loader](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-loader-java): Implémentation Java pour gérer le chargement des flux GBFS et leur mise à jour en fonction des champs ttl et last_updated. Maintenu par Entur. - -
- -## Validateurs - -- [Go Validator](https://github.com/petoc/gbfs): Implémentation Go du client, du serveur et du validateur pour GBFS. -- [Validateur Java](https://central.sonatype.com/artifact/org.entur.gbfs/gbfs-validator-java): Implémentation Java du validateur pour GBFS. Maintenu par Entur. -- [npm](https://www.npmjs.com/package/@entur/gbfs-validator): Paquet Javascript du validateur [gbfs](https://github.com/MobilityData/gbfs-validator). Maintenu par Entur. - -
- ## Autres formats de données multimodales - [Alliance for Parking Data Standards (APDS)](https://www.allianceforparkingdatastandards.org/) : Formée par l'[International Parking Institute](https://www.parking.org/), la [British Parking Association](http://www.britishparking.co.uk/) et l'[European Parking Association](http://www.europeanparking.eu/), l'APDS est une organisation à but non lucratif dont la mission est de développer, de promouvoir, de gérer et de maintenir une norme mondiale uniforme qui permettra aux organisations de partager des données sur le stationnement à travers des plates-formes dans le monde entier.