Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Immutable `restructure` interface

Abierto
  • ¿Algo no está bien?
#468 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
30/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
clojure
Área
api, backend

Línea de trabajo

Comienza con la macro create-compojure-api propuesta y sus puntos de entrada generados GET, ANY, PATCH, DELETE, POST, PUT, context, routes, middleware y undocumented. Revisa cómo se reenvía el mapa de opciones inmutable a estas macros y cómo se seleccionan las extensiones de restructure. Se considera terminado cuando una configuración inmutable y restringida puede generar la API prevista sin depender del gran multimétodo extensible de restructure.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Instead of a big restructure multimethod that you need to manage extensions for, perhaps we can encourage more mix-and-match approaches that start to look like the kind of centralized config you'd expect from reitit.

One of the motivations is having full control and certainty over the restructure options for security purposes.

Since compojure-api is macro-based, the main obstacle here is forwarding the immutable config to the macros. This can be accomplished by a macro-generating macro.

e.g.,

(ns my-bare-bones-compojure-api
  "A version of compojure-api that only supports :tags."
  (:require [compojure.api.immutable :as im]
            [compojure.api.meta.tags]
            [clojure.set :as set]))

(def ^:private options
  {:restructure {:tags compojure.api.meta.tags/extension}})

(im/create-compojure-api `options)
=>
(defmacro create-compojure-api [options]
  (assert (and (seq? options)
               (= 2 (count options))
               (= 'quote (first options))
               (qualified-symbol? (second options)))
          "Options must be a quoted qualified symbol whose var contains your configuration, like: (load-api `options)")
  `(let [options# ~options]
     (defmacro ~'GET     {:style/indent 2 :arglists '([& ~'args])} [& args#] (GET options# args#))
     (defmacro ~'ANY     {:style/indent 2 :arglists '([& ~'args])} [& args#] (ANY options# args#))
     (defmacro ~'PATCH   {:style/indent 2 :arglists '([& ~'args])} [& args#] (PATCH options# args#))
     (defmacro ~'DELETE  {:style/indent 2 :arglists '([& ~'args])} [& args#] (DELETE options# args#))
     (defmacro ~'POST    {:style/indent 2 :arglists '([& ~'args])} [& args#] (POST options# args#))
     (defmacro ~'PUT     {:style/indent 2 :arglists '([& ~'args])} [& args#] (PUT options# args#))
     (defmacro ~'context
       "Like compojure.api.core/context, except the binding vector must be empty and
       no binding-style options are allowed. This is to prevent the passed routes
       from being reinitialized on every request."
       {:style/indent 2 :arglists '~'([path arg & args])}
       [path# arg# & args#]
       (context options# path# arg# args#))
     (defn ~'routes
       "Create a Ring handler by combining several handlers into one."
       {:style/indent 2 :arglists '~'([& handlers])}
       [& handlers#]
       (routes options# handlers#))
     (defmacro ~'middleware
       "Wraps routes with given middlewares using thread-first macro.
       Note that middlewares will be executed even if routes in body
       do not match the request uri. Be careful with middlewares that
       have side-effects."
       {:style/indent 1 :arglists '~'([middleware & body-exprs])}
       [middleware# & body-exprs#]
       (middleware options# middleware# body-exprs#))
     (defmacro ~'undocumented
       "Routes without route-documentation. Can be used to wrap routes,
       not satisfying compojure.api.routes/Routing -protocol."
       {:arglists '~'([& handlers])}
       [& handlers#]
       (undocumented options# handlers#))))
Lenguaje dominante
Clojure
Estrellas
1.1k
Forks
145
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de metosin/compojure-api

Todos los issues de metosin/compojure-api

Issues similares

Más issues de Clojure

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.