4

I have just started using RAML in my Java project. I am using Intellij IDEA and there my RAML file is displayed as raw text, without any text highlighting. It seems that it doesn't recognize this type of file at all.

Is there any plugin for RAML in Intellij IDEA?

Mostly I tried to google it and also checked in the list of plugins. If plugin doesn't exist, what would you suggest? It seems that then I would need to use some other tool to modify properly this file.

Rufi
  • 2,529
  • 1
  • 20
  • 41
  • It seems there is a plugin which is not doing anything: https://github.com/plducharme/raml-intellij. Currently I edit the file without any plugin. – Rainer Blessing Dec 10 '15 at 10:03
  • Any YAML plug-in will do, that's what I do in Eclipse. But consider using the Atom plug-in, which is fully RAML aware and full of awesome :) – David Dossot Dec 10 '15 at 16:50
  • Could you provide me some link to this plugin? I have tried to search, but found only Atom editor (https://atom.io/) – Rufi Dec 11 '15 at 06:32

4 Answers4

7

RESTful API Modeling Language (RAML) is a YAML-based language for describing RESTful APIs.

Intellij has a plugin for YAML syntax so you can use that for RAML.

  • Just go to settings -> Editor -> File Types.

  • Then under Recognized File Types just scroll down to YAML and select it.

  • Now just add *.raml and *.rml to the Registered Patterns section and you will get syntax highlighting.

gmoney
  • 143
  • 7
  • Thanks. Yes, I have found this way, but unfortunately I have tried only YAML/Ansible plugin which made my raml files highlighted, but in every line I get the error "unexpected toke at the end of the line", however, my raml file is fine and works. Which plugin for YAML are you using? – Rufi Jan 25 '16 at 09:24
  • I believe it is the built in code style plugin with the default YAML settings. It doesn't really do a lot in terms of error checking but it indents and gives you different colors for keys, values and comments. – gmoney Jan 25 '16 at 18:18
1

The RAML Workbench for Atom is a good way to get started. It provides a lot of guidance to writing RAML.

Peter Steiner
  • 19
  • 2
  • Thanks for the answer, but this is a separate editor as I understand, not a plugin for Intellij. – Rufi Jan 05 '16 at 06:08
1

There is a plugin Raml Intellij Plugin . It is still in beta but you can use it. You can download directly from the Intellij Repositories

machaval
  • 4,969
  • 14
  • 20
  • This one is definitely better than only a YAML plugin since it has validation and autocompletion. – Shoki Jul 19 '16 at 20:40
  • Great! I guess that this is the one that I am looking for, however, for now it was not straight forward how to set it up, was it difficult for you? – Rufi Jul 20 '16 at 06:51
  • What is your issue? – machaval Jul 22 '16 at 02:06
  • I installed the plugin and added *.raml file extension to recognized file types, now it seems that there is highlighting, however, I don't see any auto completion, what could be the issue? – Rufi Jul 26 '16 at 06:10
  • 1
    Plugin does not work as of IntelliJ 2021.2.1 – Mantas Nov 24 '21 at 22:30
  • Not compatible with any recent IDEA version since the plugin last was updated in 2017. – Aleksandr Kravets May 16 '22 at 12:33
0

The Raml plugin that I used to mantain is no longer under dev. To replace that I've added raml completion to the DataWeave Plugin. So if you install the Plugin It will also add Raml and Oas support. Saddly I needed to do this change. All these plugins are being mantain on my spare time

machaval
  • 4,969
  • 14
  • 20