swagger-api/swagger-codegen

[Java/Android] Parcelable models?

Open

#3,302 opened on Jul 5, 2016

View on GitHub
 (6 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: AndroidClient: JavaEnhancement: Featurehelp wanted

Description

As recommended by the faq here, I'm using swagger-codegen to generate and Android library with -l java --library=okhttp-gson.

It's very helpful to have swagger-codegen's generated models implement Android's Parcelable interface, so that they can be added to Intents, passed between Activitys, saved to disk, etc.

The changes needed to make models Parcelable are pretty simple, at least for my specific use case. You can see my implementation here: https://github.com/GriffinSchneider/swagger-codegen/commit/9673d4d7c7d4c5f3df1ddc5e6367457f1c3eb455

So,

  • Are Parcelable models something that you'd want to merge? I'd be happy to make whatever changes are needed.
  • If so, what do I need to do to get my branch to a mergeable state? Should Parcelable models be a command line option somehow? Do I need to add support for cases other than -l java --library=okhttp-gson? I see that -l Android exists, but the Wiki recommends that I don't use it, should I do something there?

Contributor guide

Tech stack
javaandroid
Domain
toolingmobile
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaAndroid Parcelableswagger codegen internalsMustache templates
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests making generated Java models implement Android's Parcelable interface. A reference commit (9673d4d) shows a potential implementation. Review the existing code generation templates for Java models (likely in modules/swagger codegen/src/main/resources/Java/ or similar), discuss with maintainers about whether to add a command line option, and ensure the feature works for the okhttp gson library. Also consider supporting the Android target ( l Android) if applicable.