Edit Page

api

Purpose

This folder contains the vast majority of your app's back-end logic. It is home to the 'M' and 'C' in MVC Framework.

In it you will find the following.

  • Controllers: Controllers contain most of the back-end logic for your app.
  • Models: Models are the structures that contain data for your Sails App.
  • Policies: Policies are typically used to authenticate clients and restrict access to certain parts of your app.
  • Responses: Server response logic (404 - Not Found, 500 - Server Error, etc)
  • Services: Services are similar to controller actions. They contain logic that used by your app that doesn't necessarily rely on .req() and .res().

Want to see for yourself?

An example of this directory can be found in our sample app repo, here.

Sails logo
  • Home
  • Get started
  • Support
  • Documentation
  • Documentation

For a better experience on sailsjs.com, update your browser.

Documentation

Reference Concepts App structure | Upgrading Contribution guide | Tutorials More

App Structure


  • api
    • controllers
      • .gitkeep
      • UserController.js
    • hooks
      • myHook
        • index.js
    • models
      • .gitkeep
      • User.js
    • policies
      • sessionAuth.js
    • responses
      • badRequest.js
      • forbidden.js
      • notFound.js
      • ok.js
      • serverError.js
    • services
      • .gitkeep
  • assets
    • images
      • .gitkeep
    • js
      • dependencies
        • sails.io.js
    • styles
      • importer.less
    • templates
      • .gitkeep
    • favicon.ico
    • robots.txt
  • config
    • env
      • production.js
    • locales
      • de.json
      • en.json
      • es.json
      • fr.json
    • blueprints.js
    • bootstrap.js
    • connections.js
    • cors.js
    • csrf.js
    • globals.js
    • http.js
    • i18n.js
    • local.js
    • log.js
    • models.js
    • policies.js
    • routes.js
    • session.js
    • sockets.js
    • views.js
  • tasks
    • config
      • clean.js
      • coffee.js
      • concat.js
      • copy.js
      • cssmin.js
      • jst.js
      • less.js
      • sails-linker.js
      • sync.js
      • uglify.js
      • watch.js
    • register
      • build.js
      • buildProd.js
      • compileAssets.js
      • default.js
      • linkAssets.js
      • linkAssetsBuild.js
      • linkAssetsBuildProd.js
      • prod.js
      • syncAssets.js
    • pipeline.js
    • README.md
  • views
    • 403.ejs
    • 404.ejs
    • 500.ejs
    • homepage.ejs
    • layout.ejs
  • .gitignore
  • .sailsrc
  • app.js
  • Gruntfile.js
  • package.json
  • README.md

Built with Love

The Sails framework is maintained by a web & mobile studio in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!

Sails:
  • What is Sails?
  • Treeline IDE
  • Contribute
  • Logos/artwork
About:
  • The Sails Company
  • Security
  • News
  • Legal
Help:
  • Get started
  • Documentation
  • Docs
  • Enterprise
  • Hire us

© 2012-2018 The Sails Company. 
The Sails framework is free and open-source under the MIT License.