macchiato-framework/macchiato-core

Input & output validation with api-docs (swagger)

Open

#7 opened on Dec 20, 2016

View on GitHub
 (17 comments) (0 reactions) (0 assignees)Clojure (34 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (383 stars)
PR merge metrics
 (PR metrics pending)

Description

Optional & pluggable, for handlers, maybe also for middleware. Schema is awesome and proven per today, Spec is the probable future. I could pull out a proposal for a common structure for input & output coercion with api-docs, based on our libs.

  • simple, data-driven core
  • optionally "easy" macro sugar with inferred models
  • pluggable implementation (schema, spec, other)
  • protocols for routing libs to collect routes for api-docs
  • swagger-docs (ring/spec-swagger)

what do you think?

Contributor guide

Research direction
Examine the existing metosin libraries (schema, spec) and propose a common data driven structure for input/output coercion and API documentation integration with swagger.
Tech stack
clojure
Domain
backend
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.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Clojure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40