Ability to cache for offline usage
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 25/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- typescript
- Domaine
- api
Piste de recherche
Commencez par lire src/hydra/parseHydraDocumentation.js, en particulier la section d’analyse référencée aux lignes 196-442, et examinez les tests existants qui utilisent JSON.stringify(). Définissez la limite entre la récupération et l’analyse, puis vérifiez que les spécifications d’API peuvent être restaurées pour une utilisation hors ligne sans perdre de références ; parvenir à un accord sur la conception fait partie de ce qui est considéré comme terminé.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Hi,
I'd like to be able to initialize the API specs from an existing cache in order to get the most recently known state of the api docs in case of offline usage.
Basically I need to be able to serialize the specs into JSON and deserialize from JSON. As far as I can see the tests currently utilize JSON.stringify() already which is nice but in my case I'm getting issues with an API spec which has circular references internally (e.g. a Resource is referencing another Resource its Field.reference property).
As the parseHydraDocumentation is capable of creating those references properly based on the api docs I'm currently thinking that utilizing the collected response(s) for caching and instantiate a new instance of Api with its belongings from that state.
If I see it correctly it should be sufficient to separate the "fetch" and "parse" capabilities that are currently handled implicitly in the parseHydraDocumentation - like having one separately exported function that does only the parsing which is currently done here:
I could try to come up with a PR for this but I'd like to get some opinions on that first.
Best
- Langage dominant
- TypeScript
- Étoiles
- 113
- Forks
- 80
- Merge moyen
- 2 j 18 h
- PR mergées (30 j)
- 3
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de api-platform/api-doc-parser
-
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
api-platform/api-doc-parser#158 · 1 commentaire ·
-
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
api-platform/api-doc-parser#130 ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 20/100
api-platform/api-doc-parser#129 · 1 commentaire ·
-
Why aren't hydra and openapi3 generating the same componentsPeut-être à nouveau libre @J3m5 l’a pris il y a 483 jours, et aucune pull request n’est ouverte. Ouverte
api-platform/api-doc-parser#125 · 1 commentaire · 1 personne assignée ·
-
fetchResource loads actual items from the API due to wrong queryParameterPeut-être à nouveau libre @soyuka l’a pris il y a 701 jours, et aucune pull request n’est ouverte. Ouverte
api-platform/api-doc-parser#115 · 4 commentaires · 1 personne assignée ·
Toutes les issues de api-platform/api-doc-parser
Issues similaires
-
chore v2
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
modelcontextprotocol/servers#5115 ·
Les mainteneurs répondent en général sous 1 jour
-
beginner bug good first issue
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
philaconvalley/website#168 ·
Les mainteneurs répondent en général sous 1 jour
-
bug frontend good first issue
Difficulté 2/5 1-3 heures Accessibilité débutants 86/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
oss-slu/lrda_mobile#294 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
hatchet-dev/hatchet#5179 ·
Les mainteneurs répondent en général sous 1 jour