Code Monkey home page Code Monkey logo

Comments (4)

rurounijones avatar rurounijones commented on August 28, 2024

Does this tie in with the JSON schemas? Using JSON schemas for request and response objects is immensely useful and would be even more so if we can link to them from any part of our API.

Edit, I have just read #19 and #20 which seems to be more appropriate to the above. I am therefore not sure what your image is for this issue.

from api-blueprint.

zdne avatar zdne commented on August 28, 2024

Not directly related to JSON schemas although a JSON schema (being an asset of API blueprint) could be a part of a data dictionary.

Take this issue more like an "umbrella issue" where #19 (and maybe even #20) are a prerequisite to have separate files (data bags) where you store your payloads referenced in blueprint.

e.g. (brainstorming here):

A data bag file:

# My Payload (application/json)
+ Headers

        A:1

+ Body

        { "message" : "Hello World" }

A blueprint file:

# GET /1
+ response 200

    [My Payload][]

This is of course closely related, but not identical, to #8.

from api-blueprint.

zdne avatar zdne commented on August 28, 2024

Closing this issue as duplicate. This issue should be addressed by Drafter apiaryio/snowcrash#57 including #8 Modularity and #19 Referenced Payloads and #20 External Assets.

from api-blueprint.

zdne avatar zdne commented on August 28, 2024

This will be addressed with the introduction of MSON in API Blueprint. See #117 (comment)

from api-blueprint.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.