restify/node-restify

serveStatic is non-intuitive

Open

#535 opened on Feb 18, 2014

View on GitHub
 (33 comments) (0 reactions) (0 assignees)JavaScript (10,695 stars) (983 forks)batch import
BugHelp WantedServe

Description

KISS: Keep it simple stupid. Please make it this for static files plugins, all people have the same problem, in my ofice 5 persons give me the same as bug!!

if you assign this:

server.get(/\/docs\/public\/?.*/, restify.serveStatic({
  directory: './public'
}));

will mean that if you get the url "domain.com/docs/public" this will be load the content of "public" folder. END. Not at prefix for the entire route path... and your fairy tales... Kiss men, kiss...

Contributor guide

Tech stack
javascriptnodejsrest api
Domain
backendapideveloper experience
Issue type
bug
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.
mostly clear
Prerequisites
Basic understanding of Node.jsFamiliarity with Restify frameworkStatic file serving concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review the discussion in issue #535 about the non intuitive behavior of serveStatic. Examine the current implementation of serveStatic in the repository (likely in lib/plugins/static.js). The main request is to simplify the static file serving so that the directory argument maps directly without the route path prefix. Look for any proposed solutions in the comments and consider how to change the function signature or behavior without breaking existing usage. Then implement and test the change.