Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Kotlin User Group Berlin: Everything is an API

Kotlin User Group Berlin: Everything is an API

When creating a new app module, or modularising an existing one, it becomes easy to forget who might be consuming it. It becomes easy to forget that every decision you make will affect how it is used, or in the worst case, abused. We’re told that code should document itself, but how do these design decisions reflect in the understanding of intended use?

Just because we might not be exposing a module as a public or open-sourced library, doesn’t mean we can’t benefit from making good decisions towards an effective and sensible API.

Ash Davies

May 25, 2023

More Decks by Ash Davies

Other Decks in Programming


  1. Everything is an API Kotlin User Group Berlin - Mai

    23’ 󰎲 Ash Davies Android / Kotlin GDE - Berlin [email protected]
  2. What is an API? Article Periodocal Incollection…? Accountable Property Inventory...?

    Acquisition Program Integration…? Academic Performance Index…? Asset Priority Index....? Annual Parasite Incidence…?
  3. Application Programming Interface noun A set of functions and procedures

    allowing the creation of applications that access the features or data of an operating system, application, or other service.
  4. Language 🗣 󰎼 ¿Qué tal? 󰧻 Helô 󰏃 Salut! 󰑒

    Pryvit 󰏅 Hello! 󰏢 Ciao 󰎩 Nǐ hǎo 󰎲 Hallo 󰐨 Oi 󰎺 Ahlan 󰏮Anyoung 󰐴 Hej 󰏏 Yassou 󰑍 Selam
  5. Application Programming Interface Representational State Transfer Simple Object Access Protocol

    Remote Procedure Call Transactional Agreement Protocol Atomic Resource Translation Application Programming Interface
  6. APIs { "total_count": 2, "artifacts": [ { "id": 11, "node_id":

    "MDg6QXJ0aWZhY3QxMQ==", "name": "Rails", "size_in_bytes": 556, "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", "updated_at": "2020-02-21T14:59:22Z" } ] What does an API look like?
  7. • SOAP (XML) • RESTful (JSON) • GraphQL • gRPC

    (Proto) APIs Protocols Just a small slice... monkeyuser.com
  8. Software Development Kit noun A set of tools for third-party

    developers to use in producing applications using a particular framework or platform. "the documentation and SDKs have already been updated to reflect the new capabilities"
  9. • Increased learning curve • Longer to peer review •

    Unpleasant to resolve • Increased risk of bugs • Slowed feature delivery API Decisions Cost of Technical Debt
  10. “Debugging is like being the detective in a crime movie

    where you are also the murderer” - Filipe Fortes
  11. • Your code will always be consumed by other people

    • Technical debt is not often resolved or paid back • Have respect for your colleagues, make their lives easier • Test code should also be considered production ready API Decisions Double standards
  12. “Always code as if the guy [sic] who ends up

    maintaining your code will be a violent psychopath who knows where you live” - John Woods
  13. • No such thing as perfect code • Perfect is

    the enemy of good • Perfect solution fallacy (Nirvana fallacy) • Problem for API maintainers • Done is ok, work on making it better Good Code?! 😭 Not so easy...
  14. “Dans ses écrits, un sage Italien, dit que le mieux

    est l'ennemi du bien” - Voltaire (François-Marie Arouet)
  15. • Keep your API surface as small as possible •

    Allow yourself room for change • Try not to expose behaviour Code Progressively Through abstraction...
  16. • Prefer interface contracts • Composition over inheritance • Interface

    segregation principle • Single responsibility principle Hiding Implementations... Through abstraction...
  17. • Javadoc can sometimes be useful if maintained • Code

    should always be self-documenting • Name considerably and with purpose • Consider sources of code smell Usefulness of Documentation “What’s a Javadoc?!”
  18. • Conditional statements • Iteration or recursion • Polymorphism •

    Mutability • Significant indentation Code Smell 👃 “My God! What is that smell?” - Veronica Corningstone
  19. “There are only two hard things in Computer Science: cache

    invalidation and naming things” - Phil Karlton
  20. Meaningful Naming for (i: Int in kS) { try {

    c.connect(i) } catch (e: Throwable) { // Meh 󰤇 } } Unclear purpose or intention
  21. Meaningful Naming for (index: Int in keySet) { try {

    client.connect(index) } catch (ignored: Throwable) { } } Unclear purpose or intention
  22. Meaningful Naming for (index: Int in keySet) { try {

    client.connect(index) } catch (ignored: IndexOutOfBoundsException) { } } Unclear purpose or intention
  23. Meaningful Naming internal suspend infix fun String.contains(value: String): Boolean Signatures

    Method will return a result asynchronously, can only be accessed by coroutine or by another suspended method
  24. Meaningful Naming internal suspend infix fun String.contains(value: String): Boolean Signatures

    Method can be used with the Kotlin infix notation Eg. val result: Boolean = “12345” contains “234”
  25. Meaningful Naming internal suspend infix fun String.contains(value: String): Boolean Signatures

    Receiver indicates the scope of the function, must be called as an extension on this type
  26. Meaningful Naming internal suspend infix fun String.contains(value: String): Boolean Signatures

    Named parameters with type give us information about how to call the method
  27. Meaningful Naming fun updateClaimWithPolicyDetails(c: Claim, pc: PolicyCriteria, identifier: String) fun

    getIfNotSetWithDefault(value: Any): String fun compareAndSet(value: Any): Boolean fun isNullOrEmpty(value: String): Boolean Signatures
  28. Meaningful Naming public interface ViewStateFactory { /* ... */ }

    internal class ViewStateFactoryImpl { /* ... */ } Interfaces
  29. Impure Functions var values: MutableMap<Char, Int> = mutableMapOf('a' to 1)

    fun modify(items: MutableMap<Char, Int>): Int { val b: Int = 1; items['a'] = items['a'] * b + 2; return items['a']; } val c = modify(values);
  30. Interface Composition Prefer interface composition over inheritance • Inheritance forces

    the consumer to use a base class • Limitations on extending abstract classes • Potentially exposes protected behaviour • Prohibits Kotlin interface delegation
  31. Interface Abstraction public interface CoroutineScope { public val coroutineContext: CoroutineContext

    } internal class ContextScope(context: CoroutineContext) : CoroutineScope { override val coroutineContext: CoroutineContext = context } public fun CoroutineScope(context: CoroutineContext): CoroutineScope { return ContextScope(if (context[Job] != null) context else context + Job()) } Obfuscate behaviour through interface abstraction
  32. Impact analysis, risk containment Peer review scrutiny Mob programming Android

    API council Guild meetings Democratise your API Decisions But not too much!
  33. • Always a potential for risk • Make use of

    annotations! ◦ @Deprecated(message: String, replaceWith: ReplaceWith, level: DeprecationLevel) ◦ @RequiresOptIn(message: String, level: Level) ◦ @TechnicalDebt(issue: String, message: String) ◦ @VisibleForModularisation(otherwise: ProductionVisibility) But, we’re all human… 󰤇
  34. @Deprecated( message = "CoroutineScope.rxCompletable is deprecated in favour of top-level

    rxCompletable", level = DeprecationLevel.ERROR, replaceWith = ReplaceWith("rxCompletable(context, block)") ) public fun CoroutineScope.rxCompletable( context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> Unit ): Completable = rxCompletableInternal(this, context, block) We’re all Human 󰤇 Migration Tools
  35. Half screen photo slide if text is necessary We’re all

    Human 󰤇 Decision Paralysis The worst decision is a decision not made in time.
  36. • Code that documents itself? • Code that can be

    changed easily? • Easily and readily maintainable? • Follows all the design principles? Conclusion Good code is...
  37. • Code that documents itself? • Code that can be

    changed easily? • Easily and readily maintainable? • Follows all the design principles? • Code that can be easily deleted. Conclusion Good code is...
  38. “Every existing thing is born without reason, prolongs itself out

    of weakness and dies by chance.” - Jean-Paul Sartre
  39. “Every line of code is written without reason, maintained out

    of weakness, and deleted by chance” - Jean-Paul Sartre
  40. Explicit mode for library authors (Kotlin) TwoHardThing (Martin Fowler) The

    Annotated Programmer (Chet Haase) Developers: Your Poorly Named Variables Are Hurting Your Team (Bennett Garner) How modularization can speed up your Android app's built tim (Nikita Kozlov) Stefan Tilkov on Twitter: "Many enterprise IT departments have become big fans of an “API-first“ strategy" The Human Cost of Tech Deb (Erik Dietrich) Everything is an API Further Reading