Giter Club home page Giter Club logo

raml-dotnet-parser's Introduction

RAML.org Website

This repository contains the source code for the raml.org website written in Jekyll

Requirements

Running locally

Pull the code locally:

$ git clone [email protected]:raml-org/raml-org.git

Enter directory:

$ cd raml-org

Install all dependencies:

$ bundle install

Build & run the site:

$ bundle exec jekyll serve

How to add projects to the projects page?

RAML.org includes a projects page that lists tools around RAML that either are community or commercial driven. If you think, your project should be in this list, please fork this repository, add it into the projects.yml file, and send us a PR. We will review and let you know if we will be able to list it.

Another way to make sure your project is linked to our projects page is through assigning topics to your Github project. Links to each topics are below the list of projects on the projects page. The following topics are available:

Topic Description
raml-design Includes projects that specifically support people with the design of RAML documents.
raml-document Includes projects that focus on the documentation of APIs using RAML documents.
raml-build Includes projects that focus on build client or server code based on RAML documents.
raml-parser Includes projects that parses/validates RAML documents.
raml-test Includes projects that support people testing APIs based on RAML documents.
raml-utilities Includes other projects that do not fall into the other topics like converters.

Topics need to be assigned and managed by the owner of a project. Additionally, we still recommend people to search on Github for more projects that might not have these topics assigned.

Contribution

RAML's website is in fact an open source project and your contribution is very much appreciated. Before you start, you should check for open issues or open a fresh issue to start a discussion around an idea that you'd like to see on our website or a bug. If you want to support us fixing issues, please follow the steps below:

  1. Fork the repository on Github and make your changes on the develop branch (or branch off of it).
  2. Run the website to see if you fixed the issue.
  3. Send a pull request (with the develop branch as the target).

We will review your PR, comment if necessary, and merge it into our staging branch stg.

You can contribute to the following:

  • spelling mistakes
  • new projects
  • blog posts
  • and others, after carefully reviewing the issue you created

raml-dotnet-parser's People

Contributors

svc-scm avatar woodp avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

raml-dotnet-parser's Issues

Call for maintainers

If you're interested in maintaining this project, feel free to leave a comment here.

Exception when loading raml document

I've download the source for the parser and added it to a simple console app project. I've compiled the project (success) and then tried to run (exception thrown). The code that loads the file is...

async Task<Raml.Parser.Expressions.RamlDocument> ParseRamlFile(string ramlFileName) {
Raml.Parser.RamlParser raml_parser = new Raml.Parser.RamlParser();
return await raml_parser.LoadAsync(ramlFileName);
}

which throws the following error...

Error parsing: while reading c:/wip/traits/status_codes.raml
cannot read c:/wip/traits/status_codes.raml (Error: ENOENT, open 'c:\wip\traits\status_codes.raml')

Here is the raml source

%RAML 0.8


title: Fragomen Connect
version: v1
protocols: [HTTP,HTTPS]
baseUri: http://ims-uat.rst.fragomen.net
traits:

  • !include traits/status_codes.raml
    securitySchemes:
  • basic:
    type: Basic Authentication
    /utl/v1/network:
    /connect:
    get: !include v1/utl/network/route/get/connect.raml
    /anonymous:
    get: !include v1/utl/network/route/get/connect_anonymous.raml

All of the referenced files are there. If I run the raml2html tool, it will process the file and generate the html output (and it is correct). I did test using the 'box.raml' file that was provided with the Ram.Parser.Tests project. It worked, but I don't think it had any external references.

Is there something that needs to be set, path wise, before loading a raml document?

Access violation

Hi All,

I am getting access violation exception when Iโ€™m trying to call the load method from web application. Has anyone faced such an issue?

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.